taventifor developers
API reference

Public API

Base URL 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()

ParameterInDescription
subdomainpathThe restaurant's subdomain, e.g. beastie.
Example
curl "https://api.taventi.app/v1/storefronts/beastie"
Response 200 · StorefrontResponse
FieldTypeNotes
organizationobject
organization.slugstring
organization.namestring
organization.descriptionobject | null
organization.description.nlstring
organization.description.frstring
organization.description.enstring
organization.defaultLocale"nl" | "fr" | "en"
organization.brandingobject
organization.branding.logoUrlstring | null
organization.branding.logoFileIdstring (uuid) | null
organization.branding.coverUrlstring | null
organization.branding.coverFileIdstring (uuid) | null
organization.branding.primaryColorstring
organization.branding.accentColorstring
locationsobject[]
locations[].idstring (uuid)
locations[].slugstring
locations[].nameobject
locations[].name.nlstring
locations[].name.frstring
locations[].name.enstring
StatusCodeWhen
404storefront_not_foundNo 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()

ParameterInDescription
subdomainpathThe restaurant's subdomain.
keypathprivacy or terms.
Example
curl "https://api.taventi.app/v1/storefronts/beastie/pages/privacy"
Response 200 · ContentPage
FieldTypeNotes
key"privacy" | "terms"
bodyobject | null
body.nlstring
body.frstring
body.enstring
updatedAtstring (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()

ParameterInDescription
slugpathThe location's slug, e.g. beastie-antwerp.
Example
curl "https://api.taventi.app/v1/locations/beastie-antwerp/menu"
Response 200 · LocationMenuResponse
FieldTypeNotes
locationobject
location.idstring (uuid)
location.slugstring
location.nameobject
location.name.nlstring
location.name.frstring
location.name.enstring
location.timeZonestring
location.addressobject
location.address.line1string
location.address.line2string
location.address.postalCodestring
location.address.citystring
location.address.countrystring2–2 characters
location.phonestring | null
location.emailstring | null
location.openingHoursobject[]
location.openingHours[].dayinteger0–6
location.openingHours[].opensstring
location.openingHours[].closesstring
location.specialDatesobject[]
location.specialDates[].datestring (date)
location.specialDates[].closedboolean
location.specialDates[].periodsobject[]
location.specialDates[].periods[].opensstring
location.specialDates[].periods[].closesstring
location.takeawayobject
location.takeaway.enabledboolean
location.takeaway.pausedboolean
location.takeaway.minimumOrderCentsinteger0–9007199254740991
location.reservationsobject
location.reservations.enabledboolean
location.reservations.minPartySizeinteger-9007199254740991–9007199254740991
location.reservations.maxPartySizeinteger-9007199254740991–9007199254740991
menuobject
menu.idstring (uuid)
menu.nameobject
menu.name.nlstring
menu.name.frstring
menu.name.enstring
menu.currency"EUR"
menu.categoriesobject[]
menu.categories[].idstring (uuid)
menu.categories[].nameobject
menu.categories[].name.nlstring
menu.categories[].name.frstring
menu.categories[].name.enstring
menu.categories[].descriptionobject | null
menu.categories[].description.nlstring
menu.categories[].description.frstring
menu.categories[].description.enstring
menu.categories[].productsobject[]
menu.categories[].products[].idstring (uuid)
menu.categories[].products[].nameobject
menu.categories[].products[].descriptionobject | null
menu.categories[].products[].priceCentsinteger0–9007199254740991
menu.categories[].products[].imageUrlstring (uri) | null
menu.categories[].products[].allergensstring[]
menu.categories[].products[].dietarystring[]
menu.categories[].products[].availableboolean
menu.categories[].products[].modifierGroupIdsstring (uuid)[]
menu.modifierGroupsobject[]
menu.modifierGroups[].idstring (uuid)
menu.modifierGroups[].nameobject
menu.modifierGroups[].name.nlstring
menu.modifierGroups[].name.frstring
menu.modifierGroups[].name.enstring
menu.modifierGroups[].minSelectinteger0–9007199254740991
menu.modifierGroups[].maxSelectinteger | nullat most 9007199254740991
menu.modifierGroups[].modifiersobject[]
menu.modifierGroups[].modifiers[].idstring (uuid)
menu.modifierGroups[].modifiers[].nameobject
menu.modifierGroups[].modifiers[].priceDeltaCentsinteger-9007199254740991–9007199254740991
menu.modifierGroups[].modifiers[].availableboolean
StatusCodeWhen
404location_not_foundNo location has this slug.
404menu_not_foundThe 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()

Example
curl "https://api.taventi.app/v1/allergens"
Response 200 · PublicAllergenList
FieldTypeNotes
[].codestring
[].nameobject
[].name.nlstring
[].name.frstring
[].name.enstring

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

FieldTypeRequiredNotes
locationIdstring (uuid)Yes
linesobject[]Yes1–100 items
lines[].productIdstring (uuid)Yes
lines[].quantityintegerYes1–99
lines[].modifierIdsstring (uuid)[]at most 50 items · default []
Example
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
FieldTypeNotes
locationIdstring (uuid)
currency"EUR"
linesobject[]
lines[].productIdstring (uuid)
lines[].quantityinteger-9007199254740991–9007199254740991
lines[].modifierIdsstring (uuid)[]
lines[].unitPriceCentsinteger0–9007199254740991
lines[].lineTotalCentsinteger0–9007199254740991
itemCountinteger-9007199254740991–9007199254740991
subtotalCentsinteger0–9007199254740991
totalCentsinteger0–9007199254740991
StatusCodeWhen
422cart_invalidA 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.

ParameterInDescription
slugpathThe location's slug, e.g. beastie-antwerp.
Example
curl "https://api.taventi.app/v1/locations/beastie-antwerp/pickup-slots"
Response 200 · PickupSlotsResponse
FieldTypeNotes
timeZonestring
acceptingOrdersboolean
asapobject
asap.availableboolean
asap.pickupAtstring (ISO date-time) | null
slotsobject[]
slots[].startsAtstring (ISO date-time)
slots[].endsAtstring (ISO date-time)
slots[].availableboolean

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.

ParameterInDescription
Idempotency-KeyheaderRequired. Unique per checkout (16–128 letters, digits, _ or -); reuse it to retry.

Body

FieldTypeRequiredNotes
locationIdstring (uuid)Yes
linesobject[]Yes1–100 items
lines[].productIdstring (uuid)Yes
lines[].quantityintegerYes1–99
lines[].modifierIdsstring (uuid)[]at most 50 items · default []
customerobjectYes
customer.namestringYes1–120 characters
customer.phonestringYes
customer.emailstring (email)at most 254 characters
pickupobjectYes
pickup.type"asap" | "scheduled"Yes
pickup.atstring (ISO date-time)
notesstringat most 500 characters
locale"nl" | "fr" | "en"default "nl"
source"storefront" | "widget" | "api" | "dashboard"default "api"
Example
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
FieldTypeNotes
idstring (uuid)
numberstring
locationIdstring (uuid)
status"pending" | "accepted" | "rejected" | "preparing" | "ready" | "completed" | "cancelled"
pickupAtstring (ISO date-time)
isAsapboolean
customerobject
customer.namestring1–120 characters
customer.phonestring
customer.emailstring (email)at most 254 characters
notesstring | null
itemsobject[]
items[].idstring (uuid)
items[].productIdstring (uuid) | null
items[].nameobject
items[].name.nlstring
items[].name.frstring
items[].name.enstring
items[].quantityinteger-9007199254740991–9007199254740991
items[].unitPriceCentsinteger0–9007199254740991
items[].lineTotalCentsinteger0–9007199254740991
items[].modifiersobject[]
items[].modifiers[].modifierIdstring (uuid)
items[].modifiers[].nameobject
items[].modifiers[].name.nlstring
items[].modifiers[].name.frstring
items[].modifiers[].name.enstring
items[].modifiers[].priceDeltaCentsinteger-9007199254740991–9007199254740991
currency"EUR"
subtotalCentsinteger0–9007199254740991
totalCentsinteger0–9007199254740991
paymentobject
payment.method"pay_at_pickup"
payment.status"unpaid" | "paid" | "refunded"
createdAtstring (ISO date-time)
StatusCodeWhen
400idempotency_key_requiredThe header is missing.
400source_not_allowedsource is dashboard (staff only).
409idempotency_key_reusedThe key was used for another order.
409takeaway_closedThe location isn't taking orders.
409pickup_time_unavailableThe chosen time just filled up.
409restaurant_unavailableThe restaurant isn't taking orders or bookings online.
422cart_invalidA 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.

ParameterInDescription
idpathThe order's id.
Example
curl "https://api.taventi.app/v1/orders/<id>/status"
Response 200 · OrderStatusResponse
FieldTypeNotes
idstring (uuid)
numberstring
status"pending" | "accepted" | "rejected" | "preparing" | "ready" | "completed" | "cancelled"
pickupAtstring (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.

ParameterInDescription
slugpathThe location's slug, e.g. beastie-antwerp.

Query

FieldTypeRequiredNotes
datestring (date)Yes
partySizenumberYes
Example
curl "https://api.taventi.app/v1/locations/beastie-antwerp/reservations/availability?date=2026-12-04&partySize=4"
Response 200 · ReservationAvailability
FieldTypeNotes
locationIdstring (uuid)
timeZonestring
acceptingReservationsboolean
datestring (date)
partySizeinteger1–100
minPartySizeinteger-9007199254740991–9007199254740991
maxPartySizeinteger-9007199254740991–9007199254740991
lastDatestring (date)
timesobject[]
times[].startsAtstring (ISO date-time)
times[].availableboolean

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.

ParameterInDescription
Idempotency-KeyheaderRequired. Unique per checkout (16–128 letters, digits, _ or -); reuse it to retry.

Body

FieldTypeRequiredNotes
locationIdstring (uuid)Yes
startsAtstring (ISO date-time)Yes
partySizeintegerYes1–100
guestobjectYes
guest.namestringYes1–120 characters
guest.phonestringYes
guest.emailstring (email)Yesat most 254 characters
notesstringat most 500 characters
locale"nl" | "fr" | "en"default "nl"
source"storefront" | "widget" | "api"default "api"
Example
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
FieldTypeNotes
idstring (uuid)
locationIdstring (uuid)
status"pending" | "confirmed" | "seated" | "completed" | "declined" | "cancelled" | "no_show"
startsAtstring (ISO date-time)
partySizeinteger-9007199254740991–9007199254740991
canCancelboolean
cancelUntilstring (ISO date-time)
StatusCodeWhen
409reservations_closedThe location doesn't take bookings.
409time_unavailableThe time was just taken.
409restaurant_unavailableThe restaurant isn't taking orders or bookings online.
422party_size_not_bookableToo 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.

ParameterInDescription
idpathThe reservation's id.
Example
curl "https://api.taventi.app/v1/reservations/<id>"
Response 200 · PublicReservation
FieldTypeNotes
idstring (uuid)
locationIdstring (uuid)
status"pending" | "confirmed" | "seated" | "completed" | "declined" | "cancelled" | "no_show"
startsAtstring (ISO date-time)
partySizeinteger-9007199254740991–9007199254740991
canCancelboolean
cancelUntilstring (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.

ParameterInDescription
idpathThe reservation's id.
Example
curl -X POST "https://api.taventi.app/v1/reservations/<id>/cancel"
Response 200 · PublicReservation
FieldTypeNotes
idstring (uuid)
locationIdstring (uuid)
status"pending" | "confirmed" | "seated" | "completed" | "declined" | "cancelled" | "no_show"
startsAtstring (ISO date-time)
partySizeinteger-9007199254740991–9007199254740991
canCancelboolean
cancelUntilstring (ISO date-time)

Platform

get/health

Check the API

Whether the API and its database are up, and the Taventi version.

SDK: client.health()

Example
curl "https://api.taventi.app/health"
Response 200 · HealthResponse
FieldTypeNotes
status"ok" | "degraded"
checksmap of "up" | "down"
timestring (ISO date-time)
versionstring