taventifor developers
API reference

Taventi API

Base URL https://api.taventi.app. The public endpoints work without signing in; the restaurant API at the end needs an API key.

Restaurants

get/v1/storefronts/{subdomain}

Get a restaurant

The restaurant behind a Taventi site (<subdomain>.taventi.app): name, description, default language, branding, its own address (customDomain, once connected) 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
organization.branding.template"classic" | "bistro" | "street"
organization.customDomainstring | null
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/domains/{hostname}

Get a restaurant by its own address

The same as above, for a restaurant's own connected address (e.g. order.beastie.be). customDomain in the answer is that address.

SDK: client.getStorefrontByDomain()

ParameterInDescription
hostnamepathThe address, e.g. order.beastie.be.
Example
curl "https://api.taventi.app/v1/storefronts/domains/<hostname>"
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
organization.branding.template"classic" | "bistro" | "street"
organization.customDomainstring | null
locationsobject[]
locations[].idstring (uuid)
locations[].slugstring
locations[].nameobject
locations[].name.nlstring
locations[].name.frstring
locations[].name.enstring
StatusCodeWhen
404storefront_not_foundNo restaurant has connected 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

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"
guestPassstringat most 1000 characters
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",
    "guestPass": "v1.eyJv…"
  }'
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.
422guest_check_requiredThe location checks guests (guestCheck) and guestPass is missing, expired or for another email.

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"
guestPassstringat most 1000 characters
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",
    "guestPass": "v1.eyJv…"
  }'
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.
422guest_check_requiredThe location checks guests (guestCheck) and guestPass is missing, expired or for another email.

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)

Guest checks

post/v1/guest-checks

Email a code

Against fake orders and no-shows: where a location checks guests (guestCheck: true on its menu), guests confirm their email before ordering or booking online. This emails a 6-digit code that works thirty minutes. Skip it when you already hold a guestPass for this email.

SDK: client.startGuestCheck() · At most 10 requests per 10 minutes per IP address.

Body

FieldTypeRequiredNotes
locationIdstring (uuid)Yes
emailstringYes
locale"nl" | "fr" | "en"default "nl"
Example
curl -X POST "https://api.taventi.app/v1/guest-checks" \
  -H "Content-Type: application/json" \
  -d '{
    "locationId": "6f0c…",
    "email": "lena@example.com",
    "locale": "nl"
  }'
Response 201 · GuestCheckStarted
FieldTypeNotes
checkIdstring (uuid)
expiresAtstring (ISO date-time)
StatusCodeWhen
404location_not_foundNo location has this id.
429guest_codes_too_manyThree codes for this email in 15 minutes.

post/v1/guest-checks/{checkId}/confirm

Confirm the code

A right code gives a guestPass for this restaurant and email. Send it as guestPass with orders and bookings made with that email, and keep it on the guest's device: it works for about six months, so returning guests aren't asked again.

SDK: client.confirmGuestCheck() · At most 30 requests per 10 minutes per IP address.

ParameterInDescription
checkIdpathFrom the code's answer.

Body

FieldTypeRequiredNotes
codestringYes
Example
curl -X POST "https://api.taventi.app/v1/guest-checks/<checkId>/confirm" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "482913"
  }'
Response 200 · GuestPass
FieldTypeNotes
guestPassstring
emailstring
expiresAtstring (ISO date-time)
StatusCodeWhen
404guest_check_not_foundUnknown or already used: send a new code.
422guest_code_wrongThe code isn't right.
422guest_code_expiredThe thirty minutes are over.
422guest_code_triesFive wrong tries: send a new code.

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

Restaurant API

A restaurant's own endpoints, for its own systems and its agency: today's orders, accepting them, selling out a dish, the day's bookings. The owner (or anyone allowed to manage integrations) makes a key under Integrations → API keys, chooses what it may do, and copies it once. The restaurant's id is shown there too.

Every request
Authorization: Bearer tav_live_…
  • Keep keys on a server: never in a web page or an app, where anyone can read them.
  • A key acts as the team member who made it, limited to what it was given. When that member leaves the team or loses a permission, the key loses it too.
  • A key works for its own restaurant only; agencies get one key per restaurant. Changes made with a key are in the restaurant's activity log, with the key's name.
  • Revoking a key stops it at once.

get/v1/organizations/{organizationId}/menu

Get the menu (editable)

Every category, product and option group, with ids, shared prices and each location's own price and availability.

API key with menu.view

ParameterInDescription
organizationIdpathYour restaurant's id, shown next to its API keys (Integrations → API keys).
Example
curl "https://api.taventi.app/v1/organizations/<organizationId>/menu"
Response 200 · EditorMenu
FieldTypeNotes
idstring (uuid)
nameobject
name.nlstring
name.frstring
name.enstring
categoriesobject[]
categories[].nameobject
categories[].name.nlstring
categories[].name.frstring
categories[].name.enstring
categories[].descriptionobject | null
categories[].description.nlstring
categories[].description.frstring
categories[].description.enstring
categories[].idstring (uuid)
categories[].positioninteger-9007199254740991–9007199254740991
categories[].productsobject[]
categories[].products[].categoryIdstring (uuid)
categories[].products[].nameobject
categories[].products[].name.nlstring
categories[].products[].name.frstring
categories[].products[].name.enstring
categories[].products[].descriptionobject | null
categories[].products[].description.nlstring
categories[].products[].description.frstring
categories[].products[].description.enstring
categories[].products[].priceCentsinteger0–9007199254740991
categories[].products[].imageFileIdstring (uuid) | null
categories[].products[].allergensstring[]at most 30 items
categories[].products[].dietary"vegetarian" | "vegan" | "gluten-free" | "halal" | "spicy"[]
categories[].products[].isAvailableboolean
categories[].products[].modifierGroupIdsstring (uuid)[]at most 20 items
categories[].products[].idstring (uuid)
categories[].products[].imageUrlstring (uri) | null
categories[].products[].positioninteger-9007199254740991–9007199254740991
categories[].products[].locationOverridesobject[]
modifierGroupsobject[]
modifierGroups[].idstring (uuid)
modifierGroups[].nameobject
modifierGroups[].name.nlstring
modifierGroups[].name.frstring
modifierGroups[].name.enstring
modifierGroups[].minSelectinteger-9007199254740991–9007199254740991
modifierGroups[].maxSelectinteger | null-9007199254740991–9007199254740991
modifierGroups[].positioninteger-9007199254740991–9007199254740991
modifierGroups[].modifiersobject[]
modifierGroups[].modifiers[].idstring (uuid)
modifierGroups[].modifiers[].nameobject
modifierGroups[].modifiers[].name.nlstring
modifierGroups[].modifiers[].name.frstring
modifierGroups[].modifiers[].name.enstring
modifierGroups[].modifiers[].priceDeltaCentsinteger-100000–100000
modifierGroups[].modifiers[].isAvailableboolean
modifierGroups[].modifiers[].positioninteger-9007199254740991–9007199254740991
locationsobject[]
locations[].idstring (uuid)
locations[].slugstring
locations[].nameobject
locations[].name.nlstring
locations[].name.frstring
locations[].name.enstring

patch/v1/organizations/{organizationId}/menu/products/{id}

Update a product

Change any of its fields, e.g. { "isAvailable": false } when it sells out, or { "priceCents": 1350 }. Answers with the whole menu.

API key with menu.edit

ParameterInDescription
organizationIdpathYour restaurant's id, shown next to its API keys (Integrations → API keys).
idpathThe product's id.

Body

FieldTypeRequiredNotes
categoryIdstring (uuid)
nameobject
name.nlstring
name.frstring
name.enstring
descriptionobject | null
description.nlstring
description.frstring
description.enstring
priceCentsinteger0–9007199254740991
imageFileIdstring (uuid) | null
allergensstring[]at most 30 items
dietary"vegetarian" | "vegan" | "gluten-free" | "halal" | "spicy"[]
isAvailableboolean
modifierGroupIdsstring (uuid)[]at most 20 items
Example
curl "https://api.taventi.app/v1/organizations/<organizationId>/menu/products/<id>" \
  -H "Content-Type: application/json" \
  -d '{
    "isAvailable": false
  }'
Response 200 · EditorMenu
FieldTypeNotes
idstring (uuid)
nameobject
name.nlstring
name.frstring
name.enstring
categoriesobject[]
categories[].nameobject
categories[].name.nlstring
categories[].name.frstring
categories[].name.enstring
categories[].descriptionobject | null
categories[].description.nlstring
categories[].description.frstring
categories[].description.enstring
categories[].idstring (uuid)
categories[].positioninteger-9007199254740991–9007199254740991
categories[].productsobject[]
categories[].products[].categoryIdstring (uuid)
categories[].products[].nameobject
categories[].products[].name.nlstring
categories[].products[].name.frstring
categories[].products[].name.enstring
categories[].products[].descriptionobject | null
categories[].products[].description.nlstring
categories[].products[].description.frstring
categories[].products[].description.enstring
categories[].products[].priceCentsinteger0–9007199254740991
categories[].products[].imageFileIdstring (uuid) | null
categories[].products[].allergensstring[]at most 30 items
categories[].products[].dietary"vegetarian" | "vegan" | "gluten-free" | "halal" | "spicy"[]
categories[].products[].isAvailableboolean
categories[].products[].modifierGroupIdsstring (uuid)[]at most 20 items
categories[].products[].idstring (uuid)
categories[].products[].imageUrlstring (uri) | null
categories[].products[].positioninteger-9007199254740991–9007199254740991
categories[].products[].locationOverridesobject[]
modifierGroupsobject[]
modifierGroups[].idstring (uuid)
modifierGroups[].nameobject
modifierGroups[].name.nlstring
modifierGroups[].name.frstring
modifierGroups[].name.enstring
modifierGroups[].minSelectinteger-9007199254740991–9007199254740991
modifierGroups[].maxSelectinteger | null-9007199254740991–9007199254740991
modifierGroups[].positioninteger-9007199254740991–9007199254740991
modifierGroups[].modifiersobject[]
modifierGroups[].modifiers[].idstring (uuid)
modifierGroups[].modifiers[].nameobject
modifierGroups[].modifiers[].name.nlstring
modifierGroups[].modifiers[].name.frstring
modifierGroups[].modifiers[].name.enstring
modifierGroups[].modifiers[].priceDeltaCentsinteger-100000–100000
modifierGroups[].modifiers[].isAvailableboolean
modifierGroups[].modifiers[].positioninteger-9007199254740991–9007199254740991
locationsobject[]
locations[].idstring (uuid)
locations[].slugstring
locations[].nameobject
locations[].name.nlstring
locations[].name.frstring
locations[].name.enstring

put/v1/organizations/{organizationId}/menu/products/{id}/locations/{locationId}

Set a product's price or availability at one location

null keeps the shared value; both null removes the location's own values. Answers with the whole menu.

API key with menu.edit

ParameterInDescription
organizationIdpathYour restaurant's id, shown next to its API keys (Integrations → API keys).
idpathThe product's id.
locationIdpathThe location's id.

Body

FieldTypeRequiredNotes
priceCentsinteger | nullYes0–9007199254740991
isAvailableboolean | nullYes
Example
curl "https://api.taventi.app/v1/organizations/<organizationId>/menu/products/<id>/locations/<locationId>" \
  -H "Content-Type: application/json" \
  -d '{
    "priceCents": 1350,
    "isAvailable": null
  }'
Response 200 · EditorMenu
FieldTypeNotes
idstring (uuid)
nameobject
name.nlstring
name.frstring
name.enstring
categoriesobject[]
categories[].nameobject
categories[].name.nlstring
categories[].name.frstring
categories[].name.enstring
categories[].descriptionobject | null
categories[].description.nlstring
categories[].description.frstring
categories[].description.enstring
categories[].idstring (uuid)
categories[].positioninteger-9007199254740991–9007199254740991
categories[].productsobject[]
categories[].products[].categoryIdstring (uuid)
categories[].products[].nameobject
categories[].products[].name.nlstring
categories[].products[].name.frstring
categories[].products[].name.enstring
categories[].products[].descriptionobject | null
categories[].products[].description.nlstring
categories[].products[].description.frstring
categories[].products[].description.enstring
categories[].products[].priceCentsinteger0–9007199254740991
categories[].products[].imageFileIdstring (uuid) | null
categories[].products[].allergensstring[]at most 30 items
categories[].products[].dietary"vegetarian" | "vegan" | "gluten-free" | "halal" | "spicy"[]
categories[].products[].isAvailableboolean
categories[].products[].modifierGroupIdsstring (uuid)[]at most 20 items
categories[].products[].idstring (uuid)
categories[].products[].imageUrlstring (uri) | null
categories[].products[].positioninteger-9007199254740991–9007199254740991
categories[].products[].locationOverridesobject[]
modifierGroupsobject[]
modifierGroups[].idstring (uuid)
modifierGroups[].nameobject
modifierGroups[].name.nlstring
modifierGroups[].name.frstring
modifierGroups[].name.enstring
modifierGroups[].minSelectinteger-9007199254740991–9007199254740991
modifierGroups[].maxSelectinteger | null-9007199254740991–9007199254740991
modifierGroups[].positioninteger-9007199254740991–9007199254740991
modifierGroups[].modifiersobject[]
modifierGroups[].modifiers[].idstring (uuid)
modifierGroups[].modifiers[].nameobject
modifierGroups[].modifiers[].name.nlstring
modifierGroups[].modifiers[].name.frstring
modifierGroups[].modifiers[].name.enstring
modifierGroups[].modifiers[].priceDeltaCentsinteger-100000–100000
modifierGroups[].modifiers[].isAvailableboolean
modifierGroups[].modifiers[].positioninteger-9007199254740991–9007199254740991
locationsobject[]
locations[].idstring (uuid)
locations[].slugstring
locations[].nameobject
locations[].name.nlstring
locations[].name.frstring
locations[].name.enstring

get/v1/organizations/{organizationId}/locations/{locationId}/orders/board

Today's orders

The order board of one location: new, preparing, ready, later today, scheduled and done. Guests' phone and email need customers.contact.view too.

API key with orders.view

ParameterInDescription
organizationIdpathYour restaurant's id, shown next to its API keys (Integrations → API keys).
locationIdpathThe location's id.
Example
curl "https://api.taventi.app/v1/organizations/<organizationId>/locations/<locationId>/orders/board"
Response 200 · OrderBoard
FieldTypeNotes
nowstring (ISO date-time)
timeZonestring
takeawayobject
takeaway.enabledboolean
takeaway.pausedboolean
takeaway.prepMinutesinteger-9007199254740991–9007199254740991
activeobject[]
active[].idstring (uuid)
active[].numberstring
active[].status"pending" | "accepted" | "rejected" | "preparing" | "ready" | "completed" | "cancelled"
active[].source"storefront" | "widget" | "api" | "dashboard"
active[].pickupAtstring (ISO date-time)
active[].isAsapboolean
active[].createdAtstring (ISO date-time)
active[].customerobject
active[].customer.namestring
active[].customer.phonestring
active[].customer.emailstring | null
active[].customer.maskedboolean
active[].notesstring | null
active[].itemsobject[]
active[].items[].nameobject
active[].items[].name.nlstring
active[].items[].name.frstring
active[].items[].name.enstring
active[].items[].quantityinteger-9007199254740991–9007199254740991
active[].items[].optionsobject[]
active[].totalCentsinteger0–9007199254740991
doneobject[]
done[].idstring (uuid)
done[].numberstring
done[].status"pending" | "accepted" | "rejected" | "preparing" | "ready" | "completed" | "cancelled"
done[].source"storefront" | "widget" | "api" | "dashboard"
done[].pickupAtstring (ISO date-time)
done[].isAsapboolean
done[].createdAtstring (ISO date-time)
done[].customerobject
done[].customer.namestring
done[].customer.phonestring
done[].customer.emailstring | null
done[].customer.maskedboolean
done[].notesstring | null
done[].itemsobject[]
done[].items[].nameobject
done[].items[].name.nlstring
done[].items[].name.frstring
done[].items[].name.enstring
done[].items[].quantityinteger-9007199254740991–9007199254740991
done[].items[].optionsobject[]
done[].totalCentsinteger0–9007199254740991

post/v1/organizations/{organizationId}/orders/{id}/status

Change an order's status

Accept or reject a new order, then preparing, ready, completed, or cancelled. The guest gets the matching email.

API key with orders.edit

ParameterInDescription
organizationIdpathYour restaurant's id, shown next to its API keys (Integrations → API keys).
idpathThe order's id.

Body

FieldTypeRequiredNotes
status"pending" | "accepted" | "rejected" | "preparing" | "ready" | "completed" | "cancelled"Yes
Example
curl -X POST "https://api.taventi.app/v1/organizations/<organizationId>/orders/<id>/status" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "accepted"
  }'
Response 200 · BoardOrder
FieldTypeNotes
idstring (uuid)
numberstring
status"pending" | "accepted" | "rejected" | "preparing" | "ready" | "completed" | "cancelled"
source"storefront" | "widget" | "api" | "dashboard"
pickupAtstring (ISO date-time)
isAsapboolean
createdAtstring (ISO date-time)
customerobject
customer.namestring
customer.phonestring
customer.emailstring | null
customer.maskedboolean
notesstring | null
itemsobject[]
items[].nameobject
items[].name.nlstring
items[].name.frstring
items[].name.enstring
items[].quantityinteger-9007199254740991–9007199254740991
items[].optionsobject[]
items[].options[].nlstring
items[].options[].frstring
items[].options[].enstring
totalCentsinteger0–9007199254740991
StatusCodeWhen
409order_status_conflictThat step isn't possible now.

post/v1/organizations/{organizationId}/locations/{locationId}/takeaway/pause

Pause or resume takeaway

Stop new orders now (e.g. when the kitchen is overrun), and start again.

API key with orders.edit

ParameterInDescription
organizationIdpathYour restaurant's id, shown next to its API keys (Integrations → API keys).
locationIdpathThe location's id.

Body

FieldTypeRequiredNotes
pausedbooleanYes
Example
curl -X POST "https://api.taventi.app/v1/organizations/<organizationId>/locations/<locationId>/takeaway/pause" \
  -H "Content-Type: application/json" \
  -d '{
    "paused": true
  }'
Response 200 · PauseTakeaway
FieldTypeNotes
pausedboolean

get/v1/organizations/{organizationId}/reservations

A day's bookings

One location's bookings on one date (today and the first location when left out).

API key with reservations.view

ParameterInDescription
organizationIdpathYour restaurant's id, shown next to its API keys (Integrations → API keys).

Query

FieldTypeRequiredNotes
locationstring (uuid)
datestring (date)
Example
curl "https://api.taventi.app/v1/organizations/<organizationId>/reservations?date=2026-12-04&partySize=4"
Response 200 · ReservationDay
FieldTypeNotes
nowstring (ISO date-time)
locationIdstring (uuid)
locationsobject[]
locations[].idstring (uuid)
locations[].nameobject
locations[].name.nlstring
locations[].name.frstring
locations[].name.enstring
timeZonestring
datestring (date)
enabledboolean
hasTablesboolean
durationMinutesinteger-9007199254740991–9007199254740991
reservationsobject[]
reservations[].idstring (uuid)
reservations[].status"pending" | "confirmed" | "seated" | "completed" | "declined" | "cancelled" | "no_show"
reservations[].source"storefront" | "widget" | "api" | "phone" | "walk_in"
reservations[].startsAtstring (ISO date-time)
reservations[].endsAtstring (ISO date-time)
reservations[].partySizeinteger-9007199254740991–9007199254740991
reservations[].guestobject
reservations[].guest.namestring
reservations[].guest.phonestring | null
reservations[].guest.emailstring | null
reservations[].guest.maskedboolean
reservations[].notesstring | null
reservations[].tablesobject[]
reservations[].tables[].idstring (uuid)
reservations[].tables[].namestring
reservations[].createdAtstring (ISO date-time)

post/v1/organizations/{organizationId}/reservations/{id}/status

Change a booking's status

confirmed or declined (a pending booking), seated, no_show, completed (finished) or cancelled.

API key with reservations.edit

ParameterInDescription
organizationIdpathYour restaurant's id, shown next to its API keys (Integrations → API keys).
idpathThe reservation's id.

Body

FieldTypeRequiredNotes
status"pending" | "confirmed" | "seated" | "completed" | "declined" | "cancelled" | "no_show"Yes
Example
curl -X POST "https://api.taventi.app/v1/organizations/<organizationId>/reservations/<id>/status" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "seated"
  }'
Response 200 · BookedReservation
FieldTypeNotes
idstring (uuid)
status"pending" | "confirmed" | "seated" | "completed" | "declined" | "cancelled" | "no_show"
source"storefront" | "widget" | "api" | "phone" | "walk_in"
startsAtstring (ISO date-time)
endsAtstring (ISO date-time)
partySizeinteger-9007199254740991–9007199254740991
guestobject
guest.namestring
guest.phonestring | null
guest.emailstring | null
guest.maskedboolean
notesstring | null
tablesobject[]
tables[].idstring (uuid)
tables[].namestring
createdAtstring (ISO date-time)