Public API
https://api.taventi.app. Everything here works without signing in; the dashboard's own endpoints are private.Restaurants
get/v1/storefronts/{subdomain}
Get a restaurant
The restaurant behind a Taventi site (<subdomain>.taventi.app): name, description, default language, branding and its locations.
SDK: client.getStorefront()
| Parameter | In | Description |
|---|---|---|
subdomain | path | The restaurant's subdomain, e.g. beastie. |
curl "https://api.taventi.app/v1/storefronts/beastie"Response 200 · StorefrontResponse
| Field | Type | Notes |
|---|---|---|
organization | object | |
organization.slug | string | |
organization.name | string | |
organization.description | object | null | |
organization.description.nl | string | |
organization.description.fr | string | |
organization.description.en | string | |
organization.defaultLocale | "nl" | "fr" | "en" | |
organization.branding | object | |
organization.branding.logoUrl | string | null | |
organization.branding.logoFileId | string (uuid) | null | |
organization.branding.coverUrl | string | null | |
organization.branding.coverFileId | string (uuid) | null | |
organization.branding.primaryColor | string | |
organization.branding.accentColor | string | |
locations | object[] | |
locations[].id | string (uuid) | |
locations[].slug | string | |
locations[].name | object | |
locations[].name.nl | string | |
locations[].name.fr | string | |
locations[].name.en | string |
| Status | Code | When |
|---|---|---|
| 404 | storefront_not_found | No restaurant has it. |
get/v1/storefronts/{subdomain}/pages/{key}
Get the privacy notice or terms
The restaurant's own text in NL / FR / EN; body null means it uses Taventi's default text.
SDK: client.getStorefrontPage()
| Parameter | In | Description |
|---|---|---|
subdomain | path | The restaurant's subdomain. |
key | path | privacy or terms. |
curl "https://api.taventi.app/v1/storefronts/beastie/pages/privacy"Response 200 · ContentPage
| Field | Type | Notes |
|---|---|---|
key | "privacy" | "terms" | |
body | object | null | |
body.nl | string | |
body.fr | string | |
body.en | string | |
updatedAt | string (ISO date-time) | null |
Menus
get/v1/locations/{slug}/menu
Get a location's menu
Categories, products, options and allergens with this location's prices and availability, plus the location itself: address, opening hours, special dates, and whether it takes orders and bookings now. Prices are integer cents.
SDK: client.getLocationMenu()
| Parameter | In | Description |
|---|---|---|
slug | path | The location's slug, e.g. beastie-antwerp. |
curl "https://api.taventi.app/v1/locations/beastie-antwerp/menu"Response 200 · LocationMenuResponse
| Field | Type | Notes |
|---|---|---|
location | object | |
location.id | string (uuid) | |
location.slug | string | |
location.name | object | |
location.name.nl | string | |
location.name.fr | string | |
location.name.en | string | |
location.timeZone | string | |
location.address | object | |
location.address.line1 | string | |
location.address.line2 | string | |
location.address.postalCode | string | |
location.address.city | string | |
location.address.country | string | 2–2 characters |
location.phone | string | null | |
location.email | string | null | |
location.openingHours | object[] | |
location.openingHours[].day | integer | 0–6 |
location.openingHours[].opens | string | |
location.openingHours[].closes | string | |
location.specialDates | object[] | |
location.specialDates[].date | string (date) | |
location.specialDates[].closed | boolean | |
location.specialDates[].periods | object[] | |
location.specialDates[].periods[].opens | string | |
location.specialDates[].periods[].closes | string | |
location.takeaway | object | |
location.takeaway.enabled | boolean | |
location.takeaway.paused | boolean | |
location.takeaway.minimumOrderCents | integer | 0–9007199254740991 |
location.reservations | object | |
location.reservations.enabled | boolean | |
location.reservations.minPartySize | integer | -9007199254740991–9007199254740991 |
location.reservations.maxPartySize | integer | -9007199254740991–9007199254740991 |
menu | object | |
menu.id | string (uuid) | |
menu.name | object | |
menu.name.nl | string | |
menu.name.fr | string | |
menu.name.en | string | |
menu.currency | "EUR" | |
menu.categories | object[] | |
menu.categories[].id | string (uuid) | |
menu.categories[].name | object | |
menu.categories[].name.nl | string | |
menu.categories[].name.fr | string | |
menu.categories[].name.en | string | |
menu.categories[].description | object | null | |
menu.categories[].description.nl | string | |
menu.categories[].description.fr | string | |
menu.categories[].description.en | string | |
menu.categories[].products | object[] | |
menu.categories[].products[].id | string (uuid) | |
menu.categories[].products[].name | object | |
menu.categories[].products[].description | object | null | |
menu.categories[].products[].priceCents | integer | 0–9007199254740991 |
menu.categories[].products[].imageUrl | string (uri) | null | |
menu.categories[].products[].allergens | string[] | |
menu.categories[].products[].dietary | string[] | |
menu.categories[].products[].available | boolean | |
menu.categories[].products[].modifierGroupIds | string (uuid)[] | |
menu.modifierGroups | object[] | |
menu.modifierGroups[].id | string (uuid) | |
menu.modifierGroups[].name | object | |
menu.modifierGroups[].name.nl | string | |
menu.modifierGroups[].name.fr | string | |
menu.modifierGroups[].name.en | string | |
menu.modifierGroups[].minSelect | integer | 0–9007199254740991 |
menu.modifierGroups[].maxSelect | integer | null | at most 9007199254740991 |
menu.modifierGroups[].modifiers | object[] | |
menu.modifierGroups[].modifiers[].id | string (uuid) | |
menu.modifierGroups[].modifiers[].name | object | |
menu.modifierGroups[].modifiers[].priceDeltaCents | integer | -9007199254740991–9007199254740991 |
menu.modifierGroups[].modifiers[].available | boolean |
| Status | Code | When |
|---|---|---|
| 404 | location_not_found | No location has this slug. |
| 404 | menu_not_found | The location has no active menu. |
get/v1/allergens
List allergens
The 14 EU allergens with their names, to label the codes products carry.
SDK: client.getAllergens()
curl "https://api.taventi.app/v1/allergens"Response 200 · PublicAllergenList
| Field | Type | Notes |
|---|---|---|
[].code | string | |
[].name | object | |
[].name.nl | string | |
[].name.fr | string | |
[].name.en | string |
Takeaway
post/v1/carts/price
Price a cart
Taventi's prices and totals for a cart. Show these, never your own sums: the order is charged at these prices. Unknown products, sold-out items or options that break a group's rules answer 422 cart_invalid with the reasons in details.
SDK: client.priceCart() · At most 120 requests per minute per IP address.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
locationId | string (uuid) | Yes | |
lines | object[] | Yes | 1–100 items |
lines[].productId | string (uuid) | Yes | |
lines[].quantity | integer | Yes | 1–99 |
lines[].modifierIds | string (uuid)[] | at most 50 items · default [] |
curl -X POST "https://api.taventi.app/v1/carts/price" \
-H "Content-Type: application/json" \
-d '{
"locationId": "6f0c…",
"lines": [
{
"productId": "a12a…",
"quantity": 2,
"modifierIds": [
"c41e…"
]
}
]
}'Response 200 · PricedCart
| Field | Type | Notes |
|---|---|---|
locationId | string (uuid) | |
currency | "EUR" | |
lines | object[] | |
lines[].productId | string (uuid) | |
lines[].quantity | integer | -9007199254740991–9007199254740991 |
lines[].modifierIds | string (uuid)[] | |
lines[].unitPriceCents | integer | 0–9007199254740991 |
lines[].lineTotalCents | integer | 0–9007199254740991 |
itemCount | integer | -9007199254740991–9007199254740991 |
subtotalCents | integer | 0–9007199254740991 |
totalCents | integer | 0–9007199254740991 |
| Status | Code | When |
|---|---|---|
| 422 | cart_invalid | A line can't be ordered as sent. |
get/v1/locations/{slug}/pickup-slots
List pickup times
The pickup times guests can choose now (from opening hours, preparation time and slot capacity), the first one for “as soon as possible”, and whether the location takes orders at all.
SDK: client.getPickupSlots() · At most 120 requests per minute per IP address.
| Parameter | In | Description |
|---|---|---|
slug | path | The location's slug, e.g. beastie-antwerp. |
curl "https://api.taventi.app/v1/locations/beastie-antwerp/pickup-slots"Response 200 · PickupSlotsResponse
| Field | Type | Notes |
|---|---|---|
timeZone | string | |
acceptingOrders | boolean | |
asap | object | |
asap.available | boolean | |
asap.pickupAt | string (ISO date-time) | null | |
slots | object[] | |
slots[].startsAt | string (ISO date-time) | |
slots[].endsAt | string (ISO date-time) | |
slots[].available | boolean |
post/v1/orders
Place an order
Places a takeaway order, paid at pickup. Send a unique Idempotency-Key per checkout and reuse it when retrying: the same request with the same key returns the first order (200) instead of creating another (201).
SDK: client.createOrder() · At most 10 requests per 10 minutes per IP address.
| Parameter | In | Description |
|---|---|---|
Idempotency-Key | header | Required. Unique per checkout (16–128 letters, digits, _ or -); reuse it to retry. |
Body
| Field | Type | Required | Notes |
|---|---|---|---|
locationId | string (uuid) | Yes | |
lines | object[] | Yes | 1–100 items |
lines[].productId | string (uuid) | Yes | |
lines[].quantity | integer | Yes | 1–99 |
lines[].modifierIds | string (uuid)[] | at most 50 items · default [] | |
customer | object | Yes | |
customer.name | string | Yes | 1–120 characters |
customer.phone | string | Yes | |
customer.email | string (email) | at most 254 characters | |
pickup | object | Yes | |
pickup.type | "asap" | "scheduled" | Yes | |
pickup.at | string (ISO date-time) | ||
notes | string | at most 500 characters | |
locale | "nl" | "fr" | "en" | default "nl" | |
source | "storefront" | "widget" | "api" | "dashboard" | default "api" |
curl -X POST "https://api.taventi.app/v1/orders" \
-H "Idempotency-Key: checkout_7d1f0a7c2b9e4d51" \
-H "Content-Type: application/json" \
-d '{
"locationId": "6f0c…",
"lines": [
{
"productId": "a12a…",
"quantity": 2,
"modifierIds": []
}
],
"customer": {
"name": "Lena",
"phone": "+32 470 12 34 56",
"email": "lena@example.com"
},
"pickup": {
"type": "asap"
},
"locale": "nl"
}'Response 201 · Order
| Field | Type | Notes |
|---|---|---|
id | string (uuid) | |
number | string | |
locationId | string (uuid) | |
status | "pending" | "accepted" | "rejected" | "preparing" | "ready" | "completed" | "cancelled" | |
pickupAt | string (ISO date-time) | |
isAsap | boolean | |
customer | object | |
customer.name | string | 1–120 characters |
customer.phone | string | |
customer.email | string (email) | at most 254 characters |
notes | string | null | |
items | object[] | |
items[].id | string (uuid) | |
items[].productId | string (uuid) | null | |
items[].name | object | |
items[].name.nl | string | |
items[].name.fr | string | |
items[].name.en | string | |
items[].quantity | integer | -9007199254740991–9007199254740991 |
items[].unitPriceCents | integer | 0–9007199254740991 |
items[].lineTotalCents | integer | 0–9007199254740991 |
items[].modifiers | object[] | |
items[].modifiers[].modifierId | string (uuid) | |
items[].modifiers[].name | object | |
items[].modifiers[].name.nl | string | |
items[].modifiers[].name.fr | string | |
items[].modifiers[].name.en | string | |
items[].modifiers[].priceDeltaCents | integer | -9007199254740991–9007199254740991 |
currency | "EUR" | |
subtotalCents | integer | 0–9007199254740991 |
totalCents | integer | 0–9007199254740991 |
payment | object | |
payment.method | "pay_at_pickup" | |
payment.status | "unpaid" | "paid" | "refunded" | |
createdAt | string (ISO date-time) |
| Status | Code | When |
|---|---|---|
| 400 | idempotency_key_required | The header is missing. |
| 400 | source_not_allowed | source is dashboard (staff only). |
| 409 | idempotency_key_reused | The key was used for another order. |
| 409 | takeaway_closed | The location isn't taking orders. |
| 409 | pickup_time_unavailable | The chosen time just filled up. |
| 409 | restaurant_unavailable | The restaurant isn't taking orders or bookings online. |
| 422 | cart_invalid | A line can't be ordered as sent. |
get/v1/orders/{id}/status
Track an order
Number, status and pickup time, for a tracking page. No personal data.
SDK: client.getOrderStatus() · At most 120 requests per minute per IP address.
| Parameter | In | Description |
|---|---|---|
id | path | The order's id. |
curl "https://api.taventi.app/v1/orders/<id>/status"Response 200 · OrderStatusResponse
| Field | Type | Notes |
|---|---|---|
id | string (uuid) | |
number | string | |
status | "pending" | "accepted" | "rejected" | "preparing" | "ready" | "completed" | "cancelled" | |
pickupAt | string (ISO date-time) |
Reservations
get/v1/locations/{slug}/reservations/availability
List free times
The times a party of this size can book on a date, from the location's tables, combinations and booking settings.
SDK: client.getReservationAvailability() · At most 120 requests per minute per IP address.
| Parameter | In | Description |
|---|---|---|
slug | path | The location's slug, e.g. beastie-antwerp. |
Query
| Field | Type | Required | Notes |
|---|---|---|---|
date | string (date) | Yes | |
partySize | number | Yes |
curl "https://api.taventi.app/v1/locations/beastie-antwerp/reservations/availability?date=2026-12-04&partySize=4"Response 200 · ReservationAvailability
| Field | Type | Notes |
|---|---|---|
locationId | string (uuid) | |
timeZone | string | |
acceptingReservations | boolean | |
date | string (date) | |
partySize | integer | 1–100 |
minPartySize | integer | -9007199254740991–9007199254740991 |
maxPartySize | integer | -9007199254740991–9007199254740991 |
lastDate | string (date) | |
times | object[] | |
times[].startsAt | string (ISO date-time) | |
times[].available | boolean |
post/v1/reservations
Book a table
Books a table, confirmed at once or waiting for the restaurant, depending on its settings. Idempotent like orders.
SDK: client.createReservation() · At most 10 requests per 10 minutes per IP address.
| Parameter | In | Description |
|---|---|---|
Idempotency-Key | header | Required. Unique per checkout (16–128 letters, digits, _ or -); reuse it to retry. |
Body
| Field | Type | Required | Notes |
|---|---|---|---|
locationId | string (uuid) | Yes | |
startsAt | string (ISO date-time) | Yes | |
partySize | integer | Yes | 1–100 |
guest | object | Yes | |
guest.name | string | Yes | 1–120 characters |
guest.phone | string | Yes | |
guest.email | string (email) | Yes | at most 254 characters |
notes | string | at most 500 characters | |
locale | "nl" | "fr" | "en" | default "nl" | |
source | "storefront" | "widget" | "api" | default "api" |
curl -X POST "https://api.taventi.app/v1/reservations" \
-H "Idempotency-Key: checkout_7d1f0a7c2b9e4d51" \
-H "Content-Type: application/json" \
-d '{
"locationId": "6f0c…",
"startsAt": "2026-12-04T19:30:00+01:00",
"partySize": 4,
"guest": {
"name": "Lena",
"phone": "+32 470 12 34 56",
"email": "lena@example.com"
},
"notes": "A high chair, please",
"locale": "nl"
}'Response 201 · PublicReservation
| Field | Type | Notes |
|---|---|---|
id | string (uuid) | |
locationId | string (uuid) | |
status | "pending" | "confirmed" | "seated" | "completed" | "declined" | "cancelled" | "no_show" | |
startsAt | string (ISO date-time) | |
partySize | integer | -9007199254740991–9007199254740991 |
canCancel | boolean | |
cancelUntil | string (ISO date-time) |
| Status | Code | When |
|---|---|---|
| 409 | reservations_closed | The location doesn't take bookings. |
| 409 | time_unavailable | The time was just taken. |
| 409 | restaurant_unavailable | The restaurant isn't taking orders or bookings online. |
| 422 | party_size_not_bookable | Too few or too many guests. |
get/v1/reservations/{id}
Get a booking
Status, time and party, and whether the guest may still cancel online.
SDK: client.getReservation() · At most 120 requests per minute per IP address.
| Parameter | In | Description |
|---|---|---|
id | path | The reservation's id. |
curl "https://api.taventi.app/v1/reservations/<id>"Response 200 · PublicReservation
| Field | Type | Notes |
|---|---|---|
id | string (uuid) | |
locationId | string (uuid) | |
status | "pending" | "confirmed" | "seated" | "completed" | "declined" | "cancelled" | "no_show" | |
startsAt | string (ISO date-time) | |
partySize | integer | -9007199254740991–9007199254740991 |
canCancel | boolean | |
cancelUntil | string (ISO date-time) |
post/v1/reservations/{id}/cancel
Cancel a booking
Cancels for the guest while canCancel is true (before the location's notice).
SDK: client.cancelReservation() · At most 10 requests per 10 minutes per IP address.
| Parameter | In | Description |
|---|---|---|
id | path | The reservation's id. |
curl -X POST "https://api.taventi.app/v1/reservations/<id>/cancel"Response 200 · PublicReservation
| Field | Type | Notes |
|---|---|---|
id | string (uuid) | |
locationId | string (uuid) | |
status | "pending" | "confirmed" | "seated" | "completed" | "declined" | "cancelled" | "no_show" | |
startsAt | string (ISO date-time) | |
partySize | integer | -9007199254740991–9007199254740991 |
canCancel | boolean | |
cancelUntil | string (ISO date-time) |
Platform
get/health
Check the API
Whether the API and its database are up, and the Taventi version.
SDK: client.health()
curl "https://api.taventi.app/health"Response 200 · HealthResponse
| Field | Type | Notes |
|---|---|---|
status | "ok" | "degraded" | |
checks | map of "up" | "down" | |
time | string (ISO date-time) | |
version | string |