Developer docs

Endpoint reference

Every public API route with its parameters, fields, types and limits, generated from the OpenAPI document, with a live Try it form for read routes.

How to read this page

This page is generated from the API's own OpenAPI document, so it lists exactly the routes the API exposes and nothing else: a route added, removed or renamed in the API shows up here with the next release, and a build check fails until it does. Route paths, field names and schema names are printed as the API spells them, in every language.

Use it next to the guide pages: they explain behaviour and give request samples in cURL, JavaScript, C# and PHP, this page is the complete list of what you can send. Each route links to its guide section where there is one, and every refusal links to its explanation on the errors page.

Two things set the Try it forms apart from the rest of the docs. They send a real request from your browser to https://api.bookdineplay.com, against the fictional demo venue demo-sportsbar, using a publishable demo key that is safe to show. And they exist only for read routes: anything that would create or change data, such as a booking, is shown with its fields and never sent from here. For the base URL, headers, dates and time zones see the API overview.

Public endpoints

Every route a widget, an SDK or a guest's device may call, generated from the API's OpenAPI document. Routes under /api/venues/** need an API key; the others carry their own credential in the URL.

GET /api/venues

Operation: ListVenueDirectory

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Venue directory

Parameters

NameInTypeRequiredNullableConstraints
queryquerystringNo––
cityquerystringNo––
pagequeryinteger (int32)No––
pageSizequeryinteger (int32)No––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

No "Try it": the venue directory only answers BookDinePlay's own platform and app keys, never a venue's publishable key.

GET /api/venues/{venueSlug}

Operation: GetVenue

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Profile

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

GET /api/venues/{venueSlug}/availability

Operation: GetAvailability

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Availability

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––
datequerystringYes––
partySizequeryinteger (int32)No–default 2
resourceTypequeryBookableResourceTypeNo–default RestaurantTable
one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar
durationMinutesqueryinteger (int32)No––
groupByquerystringNo––
resourceGroupquerystring (uuid)No––
childrenqueryinteger (int32)No–default 0
includePreviousNightquerybooleanNo–default false

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

GET /api/venues/{venueSlug}/business-info

Operation: GetBusinessInfo

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Business info

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

GET /api/venues/{venueSlug}/floor-plan

Operation: GetFloorPlan

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Floor plan

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

GET /api/venues/{venueSlug}/menus

Operation: GetMenus

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Menus

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

GET /api/venues/{venueSlug}/opening-hours

Operation: GetOpeningHours

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Opening hours

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

POST /api/venues/{venueSlug}/payment-intents

Operation: CreatePaymentIntent

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Payment intents

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Request body application/json

CreatePaymentIntentRequest
FieldTypeRequiredNullableConstraintsDescription
reservationReferencestringYes––
amountnumber (double)Yes–min 0.01
max 100000
pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
currencystringYes–length 3–3
providerstringNoYes–Optional provider key. Only the local "fake" provider is available in the first milestone.
voucherCodestringNoYesmax 64 charactersA gift voucher of this venue to pay the deposit with, fully or partly (#321). When present, decimal CreatePaymentIntentRequest.Amount must equal the booking's deposit; the voucher pays what it covers (an amount voucher only — a percentage or item voucher is refused with voucher-not-applicable) and the card pays the rest. A voucher that covers everything opens no card payment at all: the response's string? PaymentIntentResponse.CheckoutUrl is then the booking's success page. The code is a bearer credential — send it in this body only, never in a URL.

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

POST /api/venues/{venueSlug}/reservations

Operation: CreateReservation

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Reservations

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––
Idempotency-KeyheaderstringNo––

Request body application/json

CreateReservationRequest
FieldTypeRequiredNullableConstraintsDescription
resourceTypeBookableResourceTypeYes–one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ.
resourceIdstringNoYes–Optional specific resource id. When omitted the service picks the first available resource of the type.
datestringYes––Venue-local date, "yyyy-MM-dd".
startstringYes––Venue-local start time, "HH:mm".
endstringNoYes–Optional venue-local end time, "HH:mm". Defaults to the resource slot length.
partySizeinteger (int32)Yes–min 1
max 200
gamesinteger (int32)NoYesmin 1
max 10
How many games to book, for resources priced per game. Defaults to 1 when omitted.
customerNamestringYes–length 2–120
emailstringYes–max 256 charactersBounded by int FieldLengths.Email — the same constant the Reservations.Email column is configured with. Without it this was unbounded from the public widget, and a long address reached SQL Server as error 2628 (issue #127).
phonestringNoYeslength 3–40Optional. 3–40 characters when supplied; blank is treated as not supplied.
notesstringNoYesmax 500 characters
depositOptInbooleanNo––Whether the guest opts in to an optional deposit (only offered when the venue enables deposits).
extrasarray of ExtraSelectionDtoNoYes–Optional extras the guest wants added to the booking, e.g. shoe rental.
extras[].extraIdstringYes––
extras[].quantityinteger (int32)Yes–min 1
max 100
durationMinutesinteger (int32)NoYesmin 15
max 1440
Requested booking length in minutes. When omitted the venue's default for the resource type applies. Must be a duration the venue offers for that type, and the whole booking must fit inside the venue's opening hours.
childreninteger (int32)NoYesmin 0
max 199
How many of int CreateReservationRequest.PartySize are children (issue #554). int CreateReservationRequest.PartySize stays the total head count and the only capacity input, so adults are PartySize - Children; at least one adult must remain. Omitted or null means no children. Refused while the venue has switched the "ask for children" setting off.
highChairsinteger (int32)NoYesmin 0
max 199
How many of the venue's high chairs / child seats the booking reserves (issue #555): 0 up to int? CreateReservationRequest.Children, and no more than the venue owns (VenueResponse.HighChairs) and has free in the booking's window. Omitted or null means none.

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

GET /api/venues/{venueSlug}/resources

Operation: GetResources

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Resources

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

GET /api/venues/{venueSlug}/events

Operation: GetEvents

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Events

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––
upcomingquerybooleanNo–default true

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

GET /api/venues/{venueSlug}/events/{eventSlug}

Operation: GetEvent

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Events

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––
eventSlugpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

POST /api/venues/{venueSlug}/events/{eventSlug}/registrations

Operation: RegisterForEvent

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Events

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––
eventSlugpathstringYes––
Idempotency-KeyheaderstringNo––

Request body application/json

EventRegistrationRequest
FieldTypeRequiredNullableConstraintsDescription
buyerNamestringYes–max 120 characters
emailstringYes–max 256 characters
phonestringNoYesmax 40 charactersOptional. Blank is treated as not supplied.
notesstringNoYesmax 1000 characters
quantityinteger (int32)Yes–min 1
max 100
How many tickets. Must not exceed the event's maxPerRegistration or its remaining capacity.
attendeesarray of stringNo––Attendee names, one per ticket, in ticket order. The first may be blank (it defaults to string EventRegistrationRequest.BuyerName); every further ticket needs a name. Fewer entries than int EventRegistrationRequest.Quantity is a validation error for the missing tickets.
childreninteger (int32)NoYesmin 0
max 99
How many of int EventRegistrationRequest.Quantity tickets are for children (issue #556), 0 up to int EventRegistrationRequest.Quantity minus 1: at least one adult ticket remains. Children pay the event's child ticket price when it has one. Omitted or null means none.

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

POST /api/venues/{venueSlug}/events/{eventSlug}/tickets/checkout

Operation: CheckoutEventTickets

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Events

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––
eventSlugpathstringYes––
Idempotency-KeyheaderstringNo––

Request body application/json

EventTicketCheckoutRequest
FieldTypeRequiredNullableConstraintsDescription
buyerNamestringYes–max 120 characters
emailstringYes–max 256 characters
phonestringNoYesmax 40 charactersOptional. Blank is treated as not supplied.
notesstringNoYesmax 1000 characters
quantityinteger (int32)Yes–min 1
max 100
How many tickets. Must not exceed the event's maxPerRegistration or its remaining capacity.
attendeesarray of stringNo––Attendee names, one per ticket, in ticket order. The first may be blank (it defaults to string EventTicketCheckoutRequest.BuyerName); every further ticket needs a name. Fewer entries than int EventTicketCheckoutRequest.Quantity is a validation error for the missing tickets.
successUrlstringNoYes–Where the guest lands after paying. Must be https and either the calling API key's origin allowlist or the platform's own guest app; omitted uses the built-in registration page (/r/{cancelToken}). A URL that fails the check answers 400 naming the field (errors.successUrl).
cancelUrlstringNoYes–Where the guest lands if they abandon Checkout. Same rule as string? EventTicketCheckoutRequest.SuccessUrl (errors.cancelUrl on failure).
voucherCodestringNoYesmax 200 charactersOptional. A gift voucher of this venue to pay part or all of the tickets with (#322), in any form the voucher code parser accepts; the card pays whatever it leaves. Only money-value vouchers apply to tickets. When it covers everything, no payment page opens: checkoutUrl is the success page and amountDue is 0. Part of the request an Idempotency-Key guards.
childreninteger (int32)NoYesmin 0
max 99
How many of int EventTicketCheckoutRequest.Quantity tickets are for children (issue #556), 0 up to int EventTicketCheckoutRequest.Quantity minus 1. Children pay the event's child ticket price when it has one; the card amount Stripe is asked for follows the split. Omitted or null means none.

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

GET /api/venues/{venueSlug}/specials

Operation: GetSpecials

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Specials

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––
datequerystringNo––
daysqueryinteger (int32)No–default 1

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

POST /api/venues/{venueSlug}/vouchers/checkout

Operation: StartVoucherCheckout

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Vouchers

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––
Idempotency-KeyheaderstringNo––

Request body application/json

StartVoucherCheckoutRequest
FieldTypeRequiredNullableConstraintsDescription
productIdstringYes–max 32 charactersThe product to buy (string VoucherOfferDto.ProductId).
amountnumber (double)NoYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$A custom-amount product only: the value to buy, within its minimum and maximum.
buyerNamestringYes–max 120 characters
buyerEmailstringYes–max 256 charactersWhere the receipt and — without a recipient e-mail — the voucher itself are sent.
recipientNamestringNoYesmax 120 characters
recipientEmailstringNoYesmax 256 charactersSends the voucher to the recipient directly (on string? StartVoucherCheckoutRequest.DeliverOn, or at once).
giftMessagestringNoYesmax 500 characters
deliverOnstringNoYes–yyyy-MM-dd, venue-local, from today to a year ahead: the day the recipient's e-mail is sent (at 09:00). Requires string? StartVoucherCheckoutRequest.RecipientEmail.
languagestringNoYes–"en" or "de": the voucher's and the e-mails' language. Defaults to the request's language.
successUrlstringNoYes–Where the buyer lands after paying. Must be https and either the calling API key's origin allowlist or the platform's own guest app; omitted uses the built-in thank-you page. A URL that fails the check answers 400 naming the field.
cancelUrlstringNoYes–Where the buyer lands if they abandon Checkout. Same rule as string? StartVoucherCheckoutRequest.SuccessUrl.

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

GET /api/venues/{venueSlug}/vouchers/offers

Operation: GetVoucherOffers

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Vouchers

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

POST /api/event-registrations/{cancelToken}/cancel

Operation: CancelEventRegistration

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: Events

Parameters

NameInTypeRequiredNullableConstraints
cancelTokenpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

GET /api/qr/{token}

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: QR codes and table sessions

Parameters

NameInTypeRequiredNullableConstraints
tokenpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Try it

Sends a live request from your browser. Paste the credential from the URL you received; no key is sent.

POST /api/qr/{token}/close

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: QR codes and table sessions

Parameters

NameInTypeRequiredNullableConstraints
tokenpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

POST /api/qr/{token}/orders

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: QR codes and table sessions

Parameters

NameInTypeRequiredNullableConstraints
tokenpathstringYes––

Request body application/json

PlaceOrderRequest
FieldTypeRequiredNullableConstraintsDescription
linesarray of OrderLineRequestYes––
lines[].menuIdstringYes––
lines[].itemNamestringYes––
lines[].quantityinteger (int32)Yes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

POST /api/qr/{token}/payment

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: QR codes and table sessions

Parameters

NameInTypeRequiredNullableConstraints
tokenpathstringYes––

Request body application/json

TabPaymentRequest
FieldTypeRequiredNullableConstraintsDescription
voucherCodestringNoYesmax 200 charactersA gift voucher of the tab's venue to pay part or all of the tab with — as typed, pasted or scanned (any form the voucher code parser accepts). The card pays whatever the voucher leaves.

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

GET /api/qr/{token}/session

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: QR codes and table sessions

Parameters

NameInTypeRequiredNullableConstraints
tokenpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Try it

Sends a live request from your browser. Paste the credential from the URL you received; no key is sent.

GET /api/registrations/{cancelToken}

Operation: GetRegistration

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: Events

Parameters

NameInTypeRequiredNullableConstraints
cancelTokenpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Try it

Sends a live request from your browser. Paste the credential from the URL you received; no key is sent.

GET /api/reservations/{cancelToken}

Operation: GetReservationByCancelToken

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: Reservations

Parameters

NameInTypeRequiredNullableConstraints
cancelTokenpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Try it

Sends a live request from your browser. Paste the credential from the URL you received; no key is sent.

POST /api/reservations/{cancelToken}/cancel

Operation: CancelReservationByToken

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: Reservations

Parameters

NameInTypeRequiredNullableConstraints
cancelTokenpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

POST /api/reservations/{cancelToken}/push

Operation: SubscribeGuestPush

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: Reservations

Parameters

NameInTypeRequiredNullableConstraints
cancelTokenpathstringYes––

Request body application/json

GuestPushRegistrationRequest
FieldTypeRequiredNullableConstraintsDescription
deviceIdstringNoYes–22 base64url characters as the server minted it, or null.

Responses

  • 200 OK · application/json → GuestPushRegistrationResponse
    GuestPushRegistrationResponse
    FieldTypeRequiredNullableConstraintsDescription
    enabledbooleanYes––False when push is not configured on the server: the client shows no opt-in and the other members are null.
    appIdstringYesYes–The public OneSignal App ID the SDK initialises with.
    externalIdstringYesYes–What the device logs in to the push provider as: pseudonymous, never the booking's token or reference. Keep it on the device and never show or log it.
    deviceIdstringYesYes–The device id to keep on the device and send with the next booking.

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

POST /api/reservations/{cancelToken}/push/unsubscribe

Operation: UnsubscribeGuestPush

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: Reservations

Parameters

NameInTypeRequiredNullableConstraints
cancelTokenpathstringYes––

Request body application/json

GuestPushUnsubscribeRequest
FieldTypeRequiredNullableConstraintsDescription
deviceIdstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

GET /api/tickets/{code}

Operation: GetTicket

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: Events

Parameters

NameInTypeRequiredNullableConstraints
codepathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Try it

Sends a live request from your browser. Paste the credential from the URL you received; no key is sent.

POST /api/venues/{venueSlug}/messages

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Messaging

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Request body application/json

StartConversationRequest
FieldTypeRequiredNullableConstraintsDescription
guestNamestringYes––
guestEmailstringYes––
subjectstringYes––
bodystringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Examples only: this route creates or changes data, so the reference never sends it. See the guide above for request samples.

GET /api/vouchers/{code}

Operation: GetGuestVoucher

Needs no API key: the credential is part of the URL (a QR token, ticket code, cancel token or voucher code the guest received).

Guide and examples: Vouchers

Parameters

NameInTypeRequiredNullableConstraints
codepathstringYes––

Responses

  • 200 OK · application/json → GuestVoucherResponse
    GuestVoucherResponse
    FieldTypeRequiredNullableConstraintsDescription
    venueSlugstringYes––
    venueNamestringYes––
    displayCodestringYes––The code in its display form (K7QM-2XRP-9DTA-HV3N-8W4F) — the caller already holds it; it is echoed so the page never has to re-derive it.
    kindVoucherKindYes–one of: Amount, Percentage, ItemWhat a voucher is worth, and so how it redeems.
    statusVoucherDisplayStatusYes–one of: Active, PartlyUsed, UsedUp, Expired, VoidedWhat the guest sees: active, partly used, used up, expired or voided.
    currencystringYes––The voucher's currency (ISO 4217).
    balancenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$What an VoucherKind.Amount voucher can still pay, live online checkouts subtracted. Null for percentage and item vouchers, which are used once.
    faceValuenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The value an VoucherKind.Amount voucher was issued with.
    percentagenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$A VoucherKind.Percentage voucher's discount, 0.01–100.
    maxDiscountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The venue's optional cap on a percentage discount, in money.
    itemNamestringYesYes–An VoucherKind.Item voucher's menu item, as named at issue.
    expiresOnstringYes––The last valid day, venue-local, yyyy-MM-dd.
    termsstringYesYes–The venue's voucher terms as snapshotted at issue, in the voucher's language.
    recipientNamestringYesYes–
    giftMessagestringYesYes–
    guestUrlstringYes––This page's own address in the guest Web App, {AppBaseUrl}/v/{DisplayCode}.
    qrSvgstringYes––A self-contained SVG QR code of GuestUrl.
  • 404 Not Found · application/problem+json → ProblemDetails
  • 429 Too Many Requests · application/problem+json → ProblemDetails

Problem types

Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.

Try it

Sends a live request from your browser. Paste the credential from the URL you received; no key is sent.

GET /api/venues/{venueSlug}/highlights

Operation: GetHighlights

Needs an API key in X-BookDinePlay-Key or Authorization: Bearer. A publishable key must come from an allowed origin; a secret key must not send an Origin.

Guide and examples: Highlights

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Responses

  • 200 OK

Problem types

Refused with an RFC 7807 problem whose type links to its explanation:

All problem types

Try it

Sends a live request from your browser to the demo venue with a publishable demo key.

Authenticated endpoints

The operator console's and the platform's routes. They take an Auth0 bearer token, not an API key, and are not meant for third-party integrations, so there is no "Try it" for them. They are listed so the whole surface is documented in one place.

POST /api/admin/demo-venues/{venueSlug}/reset

Operation: AdminResetDemoVenue

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––

Responses

  • 200 OK
POST /api/admin/impersonate/{tenantId}

Operation: AdminImpersonateTenant

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
tenantIdpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/admin/me

Operation: AdminMe

Needs an Auth0 bearer token.

Responses

  • 200 OK
GET /api/admin/reservations

Operation: AdminReservations

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
venueSlugquerystringYes––
datequerystringYes––

Responses

  • 200 OK
POST /api/admin/reservations/{venueSlug}/{reference}/status

Operation: AdminSetReservationStatus

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
venueSlugpathstringYes––
referencepathstringYes––

Request body application/json

SetReservationStatusRequest
FieldTypeRequiredNullableConstraintsDescription
statusReservationStatusYes–one of: Pending, Confirmed, Cancelled, Completed, NoShow, PaidButUnavailableLifecycle status of a reservation.

Responses

  • 200 OK
POST /api/admin/stripe/test-data-cleanup

Operation: AdminStripeTestDataCleanup

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
dryRunquerybooleanNo––

Responses

  • 200 OK
GET /api/admin/tenants

Operation: AdminTenants

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/admin/tenants

Operation: AdminCreateTenant

Needs an Auth0 bearer token.

Request body application/json

CreateTenantRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––
slugstringYes––
planPlanTierYes–one of: Starter, Pro, PremiumSubscription plans a tenant can be on. Higher tiers are supersets of lower ones. Prices and gating are defined once in PlanCatalog (in BookDinePlay.Domain) so the marketing site, onboarding, and in-app entitlement checks all agree.

Responses

  • 200 OK
GET /api/admin/tenants/{id}

Operation: AdminTenantById

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
PUT /api/admin/tenants/{id}

Operation: AdminUpdateTenant

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

UpdateTenantRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––
planPlanTierYes–one of: Starter, Pro, PremiumSubscription plans a tenant can be on. Higher tiers are supersets of lower ones. Prices and gating are defined once in PlanCatalog (in BookDinePlay.Domain) so the marketing site, onboarding, and in-app entitlement checks all agree.
statusTenantStatusYes–one of: Active, Suspended, PendingBillingLifecycle status of a tenant account.
billingBillingModeNoYesone of: Manual, Stripe, AppStore, GooglePlay

Responses

  • 200 OK
POST /api/admin/tenants/{id}/billing/resync

Operation: AdminResyncTenantBilling

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/admin/tenants/{id}/operators

Operation: AdminGetTenantOperators

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/admin/tenants/{id}/operators

Operation: AdminCreateTenantOperator

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

CreateOperatorRequest
FieldTypeRequiredNullableConstraintsDescription
emailstringYes––
displayNamestringYes––
auth0SubjectstringYes––Deliberately required, not optional: OperatorContextResolver authorizes an operator by Auth0 subject alone, so a row created without one is a row that can never sign in — a silent dead end for whoever was told their account was ready. The platform admin reads this value from the Auth0 dashboard or Management API. There is no invite-by-email flow here on purpose: an unverified e-mail is not proof that the invitee owns it, and folding that decision into this endpoint would make it implicitly rather than deliberately. Bounded to int FieldLengths.Auth0Subject (128 characters), the same width Operators.Auth0Subject (and its two duplicates, Employees.Auth0Subject and LegalAcceptances.Auth0Subject) are configured with in BookDinePlayDbContext.
venueSlugstringNoYes–Restricts the operator to this one venue of the tenant (epic #458); null (the default and what every earlier client sends) makes a tenant-wide operator. A slug that is not one of the tenant's venues is refused with a validation problem. Null means the same thing on every path that reads it, so there is nothing to preserve: change it later with AssignOperatorVenueRequest.

Responses

  • 200 OK
POST /api/admin/tenants/{id}/operators/invite

Operation: AdminInviteTenantOperator

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

InviteOperatorRequest
FieldTypeRequiredNullableConstraintsDescription
emailstringYes––The invitee's e-mail address; the invite is sent here and it must not belong to a user of another Auth0 connection (Google, Apple, Microsoft) nor to an operator of another tenant.
displayNamestringYes––Shown in the console and the mail.
venueSlugstringNoYes–Optional: restricts the operator to one venue of the tenant; omitted means every venue. Only applied when the operator row is created now; an existing operator keeps its current scope.
languagestringNoYes–Optional mail language, en or de; omitted uses the tenant's UI language.

Responses

  • 200 OK
PUT /api/admin/tenants/{id}/operators/{operatorId}

Operation: AdminUpdateTenantOperator

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––
operatorIdpathstring (uuid)Yes––

Request body application/json

UpdateOperatorRequest
FieldTypeRequiredNullableConstraintsDescription
displayNamestringYes––
auth0SubjectstringYes––

Responses

  • 200 OK
PUT /api/admin/tenants/{id}/operators/{operatorId}/venue-access

Operation: AdminAssignOperatorVenue

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––
operatorIdpathstring (uuid)Yes––

Request body application/json

AssignOperatorVenueRequest
FieldTypeRequiredNullableConstraintsDescription
venueSlugstringYesYes–The one venue of the tenant to restrict the operator to, or null for tenant-wide.

Responses

  • 200 OK
GET /api/admin/tenants/{id}/venues

Operation: AdminGetTenantVenues

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/onboarding

Operation: OnboardingCreate

Needs an Auth0 bearer token.

Request body application/json

OnboardingRequest
FieldTypeRequiredNullableConstraintsDescription
tenantNamestringYes––
slugstringYes––
planPlanTierYes–one of: Starter, Pro, PremiumSubscription plans a tenant can be on. Higher tiers are supersets of lower ones. Prices and gating are defined once in PlanCatalog (in BookDinePlay.Domain) so the marketing site, onboarding, and in-app entitlement checks all agree.
emailstringYes––
displayNamestringYes––
companyCompanyProfileDtoNoYes–The billing/company profile a tenant is invoiced under: legal entity, invoice address, optional VAT id, and who to contact about billing. Mirrors BookDinePlay.Domain.Billing.CompanyProfile field for field; validation lives there and the API reports it as an RFC 7807 errors dictionary keyed by these property names in camelCase (legalName, addressLine1, postalCode, city, country, vatId, billingEmail, contactName).
company.legalNamestringYes––
company.addressLine1stringYes––
company.addressLine2stringYesYes–
company.postalCodestringYes––
company.citystringYes––
company.countrystringYes––ISO 3166-1 alpha-2 country code, e.g. "DE".
company.vatIdstringYesYes–Optional VAT identification number, e.g. "DE123456789"; format-checked only, never against a tax authority.
company.billingEmailstringYes––
company.contactNamestringYes––
intervalBillingIntervalNo–one of: Monthly, YearlyMonthly or yearly billing for the chosen plan.
acceptancesarray of AcceptLegalDocumentDtoNoYes–The legal documents the operator ticked, each at the version they were shown. Every document in force must be covered or the sign-up is refused.
acceptances[].kindLegalDocumentKindYes–one of: Terms, DataProcessingAgreementA legal document BookDinePlay publishes in numbered versions and every operator accepts at sign-up (and again when a newer version takes effect).
acceptances[].versionstringYes––
acceptances[].languagestringYes––
uiLanguagestringNoYes–The operator's UI language ("en"/"de", or a culture like "de-AT"), kept on the tenant so billing e-mails are written in it. Falls back to the request's culture.
billingOnboardingBillingSourceNoYesone of: Web, AppStore, GooglePlay

Responses

  • 200 OK
GET /api/onboarding/slug-available

Operation: OnboardingSlugAvailable

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
slugquerystringNo––

Responses

  • 200 OK
GET /api/onboarding/status

Operation: OnboardingStatus

Needs an Auth0 bearer token.

Responses

  • 200 OK
DELETE /api/operator/account

Operation: OperatorDeleteAccount

Needs an Auth0 bearer token.

Responses

  • 200 OK
GET /api/operator/billing

Operation: OperatorBillingSummary

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/billing/app-store/transactions

Operation: OperatorAttachAppStoreTransaction

Needs an Auth0 bearer token.

Request body application/json

AppStoreTransactionRequest
FieldTypeRequiredNullableConstraintsDescription
signedTransactionstringYes––The JWS; empty when TransactionId is given instead.
transactionIdstringNoYes–A StoreKit 1 transactionIdentifier: the server fetches that transaction's signed JWS from the App Store Server API ("Get Transaction Info") and verifies it exactly like a posted one. The .NET store apps use this, because .NET for iOS does not bind StoreKit 2 (OutaStory's #1163 approach). Appended (#185): payloads without it bind as before.

Responses

  • 200 OK
POST /api/operator/billing/checkout-return

Operation: OperatorCompleteBillingCheckout

Needs an Auth0 bearer token.

Request body application/json

CheckoutReturnRequest
FieldTypeRequiredNullableConstraintsDescription
sessionIdstringYes––

Responses

  • 200 OK
POST /api/operator/billing/checkout-session

Operation: OperatorStartBillingCheckout

Needs an Auth0 bearer token.

Request body application/json

StartCheckoutRequest
FieldTypeRequiredNullableConstraintsDescription
tierPlanTierYes–one of: Starter, Pro, PremiumSubscription plans a tenant can be on. Higher tiers are supersets of lower ones. Prices and gating are defined once in PlanCatalog (in BookDinePlay.Domain) so the marketing site, onboarding, and in-app entitlement checks all agree.
intervalBillingIntervalYes–one of: Monthly, YearlyBilling cadence for a subscription.

Responses

  • 200 OK
PUT /api/operator/billing/company

Operation: OperatorUpdateBillingCompany

Needs an Auth0 bearer token.

Request body application/json

CompanyProfileDto
FieldTypeRequiredNullableConstraintsDescription
legalNamestringYes––
addressLine1stringYes––
addressLine2stringYesYes–
postalCodestringYes––
citystringYes––
countrystringYes––ISO 3166-1 alpha-2 country code, e.g. "DE".
vatIdstringYesYes–Optional VAT identification number, e.g. "DE123456789"; format-checked only, never against a tax authority.
billingEmailstringYes––
contactNamestringYes––

Responses

  • 200 OK
POST /api/operator/billing/google-play/purchases

Operation: OperatorAttachGooglePlayPurchase

Needs an Auth0 bearer token.

Request body application/json

GooglePlayPurchaseRequest
FieldTypeRequiredNullableConstraintsDescription
purchaseTokenstringYes–max 512 characters
productIdstringNoYesmax 100 characters

Responses

  • 200 OK
POST /api/operator/billing/portal-session

Operation: OperatorCreateBillingPortalSession

Needs an Auth0 bearer token.

Request body application/json

PortalSessionRequest
FieldTypeRequiredNullableConstraintsDescription
intentstringYes––What the operator wants to do: manage, changePlan or cancel (matched case-insensitively). A string rather than an enum so the console's three buttons stay readable in the wire format.
tierPlanTierNoYesone of: Starter, Pro, PremiumSubscription plans a tenant can be on. Higher tiers are supersets of lower ones. Prices and gating are defined once in PlanCatalog (in BookDinePlay.Domain) so the marketing site, onboarding, and in-app entitlement checks all agree.
intervalBillingIntervalNoYesone of: Monthly, YearlyBilling cadence for a subscription.

Responses

  • 200 OK
GET /api/operator/billing/store

Operation: OperatorStoreBillingStatus

Needs an Auth0 bearer token.

Responses

  • 200 OK
GET /api/operator/employees

Operation: OperatorEmployees

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/employees

Operation: OperatorCreateEmployee

Needs an Auth0 bearer token.

Request body application/json

CreateEmployeeRequest
FieldTypeRequiredNullableConstraintsDescription
emailstringYes––
displayNamestringYes––
roleEmployeeRoleYes–one of: Manager, StaffAn employee's role within a venue.

Responses

  • 200 OK
POST /api/operator/employees/{id}/assignments

Operation: OperatorAssignResource

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

AssignResourceRequest
FieldTypeRequiredNullableConstraintsDescription
resourceIdstringYes––
resourceNamestringYes––
resourceTypeBookableResourceTypeYes–one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ.

Responses

  • 200 OK
DELETE /api/operator/employees/{id}/assignments/{resourceId}

Operation: OperatorUnassignResource

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––
resourceIdpathstringYes––

Responses

  • 200 OK
POST /api/operator/employees/{id}/status

Operation: OperatorSetEmployeeActive

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

SetEmployeeActiveRequest
FieldTypeRequiredNullableConstraintsDescription
isActivebooleanYes––

Responses

  • 200 OK
GET /api/operator/guest-blocks

Operation: OperatorListBlockedGuests

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/guest-blocks

Operation: OperatorBlockGuest

Needs an Auth0 bearer token.

Request body application/json

BlockGuestRequest
FieldTypeRequiredNullableConstraintsDescription
emailstringYesYes–
phonestringYesYes–
reasonstringYes––Why (required, at most 500 characters). Kept in the log for the window.

Responses

  • 200 OK
GET /api/operator/guest-blocks/settings

Operation: OperatorGetGuestBlockSettings

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/guest-blocks/settings

Operation: OperatorSaveGuestBlockSettings

Needs an Auth0 bearer token.

Request body application/json

SaveGuestBlockSettingsRequest
FieldTypeRequiredNullableConstraintsDescription
enabledbooleanYes––
thresholdinteger (int32)Yes––
windowMonthsinteger (int32)Yes––

Responses

  • 200 OK
POST /api/operator/guest-blocks/unblock

Operation: OperatorUnblockGuest

Needs an Auth0 bearer token.

Request body application/json

UnblockGuestRequest
FieldTypeRequiredNullableConstraintsDescription
guestRefstringYesYes–
emailstringYesYes–
phonestringYesYes–
reasonstringYes––Why (required, at most 500 characters). Kept in the log for the window.

Responses

  • 200 OK
POST /api/operator/legal/acceptances

Operation: OperatorAcceptLegalDocuments

Needs an Auth0 bearer token.

Request body application/json

AcceptLegalDocumentsRequest
FieldTypeRequiredNullableConstraintsDescription
documentsarray of AcceptLegalDocumentDtoYes––
documents[].kindLegalDocumentKindYes–one of: Terms, DataProcessingAgreementA legal document BookDinePlay publishes in numbered versions and every operator accepts at sign-up (and again when a newer version takes effect).
documents[].versionstringYes––
documents[].languagestringYes––

Responses

  • 200 OK
GET /api/operator/me

Operation: OperatorMe

Needs an Auth0 bearer token.

Responses

  • 200 OK
GET /api/operator/push/registration

Operation: OperatorPushRegistration

Needs an Auth0 bearer token.

Responses

  • 200 OK · application/json → PushRegistrationResponse
    PushRegistrationResponse
    FieldTypeRequiredNullableConstraintsDescription
    enabledbooleanYes––False when push is not configured on the server (no OneSignal app yet): the clients show no opt-in. The other two members are then null.
    appIdstringYesYes–The public OneSignal App ID the SDK initialises with.
    externalIdstringYesYes–The person's push id: pseudonymous, minted by the server, never the sign-in subject. Treat it like a session value - keep it on the device it was issued to and never show or log it.
GET /api/operator/team

Operation: OperatorTeam

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/team/invitations

Operation: OperatorInviteTeamMember

Needs an Auth0 bearer token.

Request body application/json

InviteTeamMemberRequest
FieldTypeRequiredNullableConstraintsDescription
emailstringYes––
displayNamestringYes––
roleTeamRoleNo–one of: Staff, Manager, OwnerManager or Staff (an Owner is never invited through the team).
employeeIdstring (uuid)NoYes–An employee record of this venue (or a shared one) to link the login to. Without it, an unlinked employee with the same e-mail is linked when there is exactly one.
languagestringNoYes–The invite mail's language, en or de; the account's language when omitted.

Responses

  • 200 OK
DELETE /api/operator/team/{id}

Operation: OperatorRemoveTeamMember

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
PUT /api/operator/team/{id}/employee

Operation: OperatorLinkTeamMemberEmployee

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

LinkTeamMemberEmployeeRequest
FieldTypeRequiredNullableConstraintsDescription
employeeIdstring (uuid)YesYes–

Responses

  • 200 OK
PUT /api/operator/team/{id}/role

Operation: OperatorChangeTeamMemberRole

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

ChangeTeamMemberRoleRequest
FieldTypeRequiredNullableConstraintsDescription
roleTeamRoleYes–one of: Staff, Manager, OwnerWhat a tenant's back-office user may do inside the tenant (issue #562). Ordered from least to most: a higher role can do everything a lower one can. * TeamRole.Staff: bookings, orders, the day view and guest messages at one venue, only during their shifts (#563). * TeamRole.Manager: everything a venue-bound operator can at one venue, plus its staff and shifts. * TeamRole.Owner: a tenant-wide operator; every venue, billing and the team. Never restricted by shifts. Persisted by name (nvarchar(16)); appended members only.

Responses

  • 200 OK
GET /api/operator/venue

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue

Needs an Auth0 bearer token.

Request body application/json

CreateVenueRequest
FieldTypeRequiredNullableConstraintsDescription
slugstringYes––
namestringYes––
taglinestringYes––
descriptionstringYes––
citystringYes––
countrystringYes––
timezonestringYes––
businessProfileBusinessProfileDtoYes––Venue business profile (address + contact), for the operator's edit surface.
businessProfile.legalNamestringYes––
businessProfile.addressLine1stringYes––
businessProfile.addressLine2stringYesYes–
businessProfile.citystringYes––
businessProfile.postalCodestringYes––
businessProfile.countrystringYes––
businessProfile.phonestringYes––
businessProfile.emailstringYes––
businessProfile.websitestringYesYes–
paymentPolicyPaymentPolicyDtoYes––Venue payment policy, for the operator's edit surface.
paymentPolicy.paymentsEnabledbooleanYes––
paymentPolicy.depositsEnabledbooleanYes––
paymentPolicy.currencystringYes––
paymentPolicy.defaultDepositAmountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
preferredLanguagestringNo–default en

Responses

  • 200 OK
PUT /api/operator/venue

Needs an Auth0 bearer token.

Request body application/json

UpdateVenueRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––
taglinestringYes––
descriptionstringYes––
citystringYes––
countrystringYes––
timezonestringYes––
businessProfileBusinessProfileDtoYes––Venue business profile (address + contact), for the operator's edit surface.
businessProfile.legalNamestringYes––
businessProfile.addressLine1stringYes––
businessProfile.addressLine2stringYesYes–
businessProfile.citystringYes––
businessProfile.postalCodestringYes––
businessProfile.countrystringYes––
businessProfile.phonestringYes––
businessProfile.emailstringYes––
businessProfile.websitestringYesYes–
paymentPolicyPaymentPolicyDtoYes––Venue payment policy, for the operator's edit surface.
paymentPolicy.paymentsEnabledbooleanYes––
paymentPolicy.depositsEnabledbooleanYes––
paymentPolicy.currencystringYes––
paymentPolicy.defaultDepositAmountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
preferredLanguagestringNo–default en

Responses

  • 200 OK
GET /api/operator/venue/allocation-settings

Operation: OperatorAllocationSettings

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/allocation-settings

Operation: OperatorUpdateAllocationSettings

Needs an Auth0 bearer token.

Request body application/json

UpdateAllocationSettingsRequest
FieldTypeRequiredNullableConstraintsDescription
forecastEnabledbooleanNoYes–
lookBackWeeksinteger (int32)NoYes–
quietThresholdPercentinteger (int32)NoYes–
maxSpareSeatsinteger (int32)NoYes–
relaxedExtraSpareSeatsinteger (int32)NoYes–
clearMaxSpareSeatsbooleanNo–default false

Responses

  • 200 OK
GET /api/operator/venue/api-keys

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/api-keys

Needs an Auth0 bearer token.

Request body application/json

CreateApiKeyRequest
FieldTypeRequiredNullableConstraintsDescription
labelstringYes––
typeApiKeyTypeYes–one of: Publishable, Secret, AppHow a key may be used, which decides both how it is stored and where it may be sent from.
allowedOriginsarray of stringYes––
deliveryApiKeyDeliveryNo–one of: Inline, RevealHow a newly created secret key reaches the person who asked for it (issue #501).

Responses

  • 200 OK
POST /api/operator/venue/api-keys/reveal

Needs an Auth0 bearer token.

Request body application/json

RevealApiKeyRequest
FieldTypeRequiredNullableConstraintsDescription
ticketstringYes––

Responses

  • 200 OK
DELETE /api/operator/venue/api-keys/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/app-listing

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/app-listing

Needs an Auth0 bearer token.

Request body application/json

any

Responses

  • 200 OK
GET /api/operator/venue/availability

Operation: OperatorAvailability

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
datequerystringYes––
partySizequeryinteger (int32)No–default 2
resourceTypequeryBookableResourceTypeNo–default RestaurantTable
one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar
durationMinutesqueryinteger (int32)No––
groupByquerystringNo––
resourceGroupquerystring (uuid)No––

Responses

  • 200 OK
GET /api/operator/venue/booking-durations

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/booking-durations

Needs an Auth0 bearer token.

Request body application/json

OperatorBookingDurationsDto
FieldTypeRequiredNullableConstraintsDescription
rulesarray of BookingDurationRuleDtoYes––
rules[].typeBookableResourceTypeYes–one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ.
rules[].defaultMinutesinteger (int32)Yes––
rules[].minMinutesinteger (int32)Yes––
rules[].maxMinutesinteger (int32)Yes––
rules[].stepMinutesinteger (int32)Yes––
rules[].guestSelectablebooleanYes––

Responses

  • 200 OK
GET /api/operator/venue/booking-rules

Operation: OperatorBookingRules

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/booking-rules

Operation: OperatorUpdateBookingRules

Needs an Auth0 bearer token.

Request body application/json

UpdateBookingRulesRequest
FieldTypeRequiredNullableConstraintsDescription
rulesarray of UpdateBookingRuleDtoYes––
rules[].resourceTypeBookableResourceTypeYes–one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ.
rules[].minimumNoticeMinutesinteger (int32)NoYes–
rules[].bufferMinutesinteger (int32)NoYes–
rules[].minPartySizeinteger (int32)NoYes–
rules[].maxPartySizeinteger (int32)NoYes–

Responses

  • 200 OK
GET /api/operator/venue/cancellation-policy

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/cancellation-policy

Needs an Auth0 bearer token.

Request body application/json

ReservationCancellationPolicyDto
FieldTypeRequiredNullableConstraintsDescription
enabledbooleanYes––
hoursBeforeStartinteger (int32)Yes––
depositRefundReservationDepositRefundModeNo–one of: NoOnlineRefund, RefundOnGuestCancel, ForfeitOnGuestCancelWhat happens to a deposit the guest already paid online when they cancel (issue #103). Trailing and defaulted to ReservationDepositRefundMode.NoOnlineRefund, which is today's behaviour, so a pre-0.12 payload still binds. Non-nullable on purpose, mirroring OperatorEventRegistrationSettingsDto.RefundPolicyMode: this is a whole-policy PUT that always carries every field, so there is no "the caller did not supply this" case for a null to express — see AGENTS.md's nullable-mutation-DTO rule for why the nullable shape would be the worse choice here, not the safer one.

Responses

  • 200 OK
GET /api/operator/venue/child-rules

Operation: OperatorChildRules

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/child-rules

Operation: OperatorUpdateChildRules

Needs an Auth0 bearer token.

Request body application/json

SaveChildRulesRequest
FieldTypeRequiredNullableConstraintsDescription
rulesarray of ChildRuleDtoYes––
rules[].resourceTypeBookableResourceTypeYes–one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ.
rules[].maxChildrenPerSlotinteger (int32)NoYes–Most children that may be booked on the type in the same window (all resources of the type together; 0 = no children at all). Null = no limit.
rules[].noChildrenFromstringNoYes–Start of the daily window with no children, venue-local HH:mm; set together with NoChildrenUntil. A booking running into the window is refused when it names children.
rules[].noChildrenUntilstringNoYes–End of that window, HH:mm. An end at or before the start runs past midnight; use 00:00 for "until midnight".

Responses

  • 200 OK
GET /api/operator/venue/children-settings

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/children-settings

Needs an Auth0 bearer token.

Request body application/json

any

Responses

  • 200 OK
GET /api/operator/venue/events

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/events

Needs an Auth0 bearer token.

Request body application/json

OperatorEventRequest
FieldTypeRequiredNullableConstraintsDescription
titlestringYesYes–
slugstringYesYes–
excerptstringYesYes–
descriptionMarkdownstringYesYes–
imageUrlstringYesYes–
imageAltstringYesYes–
datestring (date)YesYes–
startstring (time)YesYes–
endstring (time)YesYes–
timeLabelstringYesYes–
locationLabelstringYesYes–
registrationOperatorEventRegistrationSettingsDtoYesYes–How guests may register, as edited in the console and echoed back on every event read. On write, int? OperatorEventRegistrationSettingsDto.MaxTicketsPerRegistration null means the default (6); decimal? OperatorEventRegistrationSettingsDto.TicketPrice and string? OperatorEventRegistrationSettingsDto.Currency are only meaningful for EventRegistrationMode.Paid and are dropped on save for any other mode. DateTimeOffset? OperatorEventRegistrationSettingsDto.ClosesAt is a UTC instant. RefundPolicyMode OperatorEventRegistrationSettingsDto.RefundPolicyMode and int OperatorEventRegistrationSettingsDto.RefundHoursBeforeStart are only meaningful for EventRegistrationMode.Paid too; int OperatorEventRegistrationSettingsDto.RefundHoursBeforeStart must be 0–720 and is only read when the mode is RefundPolicyMode.FullRefundUntil. decimal? OperatorEventRegistrationSettingsDto.ChildTicketPrice (#556) is what a child's ticket costs in string? OperatorEventRegistrationSettingsDto.Currency: 0 means children are free, null that a child pays decimal? OperatorEventRegistrationSettingsDto.TicketPrice; like the price it is dropped on save for any mode but Paid.
registration.modeEventRegistrationModeYes–one of: None, Free, PaidWhether guests can register for an event, and whether a ticket costs money.
registration.capacityinteger (int32)YesYes–
registration.maxTicketsPerRegistrationinteger (int32)YesYes–
registration.closesAtstring (date-time)YesYes–
registration.ticketPricenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
registration.currencystringYesYes–
registration.refundPolicyModeRefundPolicyModeNo–one of: NoOnlineRefund, FullRefundUntilHow a Paid event's tickets may be refunded online by the guest. See BookDinePlay.Domain.Events.EventRefundPolicy. Only meaningful for EventRegistrationMode.Paid events.
registration.refundHoursBeforeStartinteger (int32)No–default 0
registration.childTicketPricenumber (double)NoYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
languagestringYesYes–

Responses

  • 200 OK
POST /api/operator/venue/events/preview

Needs an Auth0 bearer token.

Request body application/json

OperatorEventPreviewRequest
FieldTypeRequiredNullableConstraintsDescription
markdownstringYesYes–

Responses

  • 200 OK
GET /api/operator/venue/events/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
PUT /api/operator/venue/events/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

OperatorEventRequest
FieldTypeRequiredNullableConstraintsDescription
titlestringYesYes–
slugstringYesYes–
excerptstringYesYes–
descriptionMarkdownstringYesYes–
imageUrlstringYesYes–
imageAltstringYesYes–
datestring (date)YesYes–
startstring (time)YesYes–
endstring (time)YesYes–
timeLabelstringYesYes–
locationLabelstringYesYes–
registrationOperatorEventRegistrationSettingsDtoYesYes–How guests may register, as edited in the console and echoed back on every event read. On write, int? OperatorEventRegistrationSettingsDto.MaxTicketsPerRegistration null means the default (6); decimal? OperatorEventRegistrationSettingsDto.TicketPrice and string? OperatorEventRegistrationSettingsDto.Currency are only meaningful for EventRegistrationMode.Paid and are dropped on save for any other mode. DateTimeOffset? OperatorEventRegistrationSettingsDto.ClosesAt is a UTC instant. RefundPolicyMode OperatorEventRegistrationSettingsDto.RefundPolicyMode and int OperatorEventRegistrationSettingsDto.RefundHoursBeforeStart are only meaningful for EventRegistrationMode.Paid too; int OperatorEventRegistrationSettingsDto.RefundHoursBeforeStart must be 0–720 and is only read when the mode is RefundPolicyMode.FullRefundUntil. decimal? OperatorEventRegistrationSettingsDto.ChildTicketPrice (#556) is what a child's ticket costs in string? OperatorEventRegistrationSettingsDto.Currency: 0 means children are free, null that a child pays decimal? OperatorEventRegistrationSettingsDto.TicketPrice; like the price it is dropped on save for any mode but Paid.
registration.modeEventRegistrationModeYes–one of: None, Free, PaidWhether guests can register for an event, and whether a ticket costs money.
registration.capacityinteger (int32)YesYes–
registration.maxTicketsPerRegistrationinteger (int32)YesYes–
registration.closesAtstring (date-time)YesYes–
registration.ticketPricenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
registration.currencystringYesYes–
registration.refundPolicyModeRefundPolicyModeNo–one of: NoOnlineRefund, FullRefundUntilHow a Paid event's tickets may be refunded online by the guest. See BookDinePlay.Domain.Events.EventRefundPolicy. Only meaningful for EventRegistrationMode.Paid events.
registration.refundHoursBeforeStartinteger (int32)No–default 0
registration.childTicketPricenumber (double)NoYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
languagestringYesYes–

Responses

  • 200 OK
DELETE /api/operator/venue/events/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/operator/venue/events/{id}/cancel

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/operator/venue/events/{id}/check-in

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

OperatorEventCheckInRequest
FieldTypeRequiredNullableConstraintsDescription
codestringYesYes–

Responses

  • 200 OK
POST /api/operator/venue/events/{id}/publish

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/events/{id}/registrations

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––
pagequeryinteger (int32)No––
pageSizequeryinteger (int32)No––
statusquerystringNo––

Responses

  • 200 OK
GET /api/operator/venue/events/{id}/registrations.csv

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/events/{id}/registrations/{registrationId}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––
registrationIdpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/operator/venue/events/{id}/registrations/{registrationId}/cancel

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––
registrationIdpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/operator/venue/events/{id}/registrations/{registrationId}/refund

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––
registrationIdpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/operator/venue/events/{id}/tickets/{code}/undo-check-in

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––
codepathstringYes––

Responses

  • 200 OK
GET /api/operator/venue/extras

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/extras

Needs an Auth0 bearer token.

Request body application/json

SaveExtrasRequest
FieldTypeRequiredNullableConstraintsDescription
extrasarray of SaveExtraDtoYes––
extras[].idstringYesYes–
extras[].namestringYes––
extras[].descriptionstringYes––
extras[].pricenumber (double)Yes–pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
extras[].basisExtraPricingBasisYes–one of: PerPerson, PerBookingHow an extra is charged.
extras[].appliesToarray of BookableResourceTypeYes–one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar

Responses

  • 200 OK
GET /api/operator/venue/floor-plan

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/floor-plan

Needs an Auth0 bearer token.

Request body application/json

SaveFloorPlanRequest
FieldTypeRequiredNullableConstraintsDescription
placementsarray of PlacementDtoYes––
placements[].codestringYes––
placements[].zoneIdstring (uuid)YesYes–
placements[].xnumber (double)Yes–pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
placements[].ynumber (double)Yes–pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
placements[].widthnumber (double)Yes–pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
placements[].heightnumber (double)Yes–pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
placements[].shapestringYes––
placements[].rotationinteger (int32)Yes––

Responses

  • 200 OK
GET /api/operator/venue/high-chairs

Operation: OperatorHighChairs

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/high-chairs

Operation: OperatorUpdateHighChairs

Needs an Auth0 bearer token.

Request body application/json

any

Responses

  • 200 OK
GET /api/operator/venue/highlights

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/highlights

Needs an Auth0 bearer token.

Request body application/json

SaveHighlightRequest
FieldTypeRequiredNullableConstraintsDescription
statusHighlightStatusYes–one of: Draft, PublishedDraft or published.
titlestringYes––The headline.
textstringYesYes–Optional short text.
imageUrlstringYesYes–The card's image (required); an upload through POST /api/operator/venue/menus/media returns one.
linkKindHighlightLinkKindYes–one of: None, MenuItem, Event, VoucherProduct, ExternalWhat the card links to.
linkTargetstringYesYes–Required for every kind but None; refused with None.
sortOrderinteger (int32)Yes––Manual order among highlights (0 to 999).
visibleFromstring (date)YesYes–First venue-local day the card shows; null means no lower bound.
visibleTostring (date)YesYes–Last venue-local day the card shows; null means no upper bound.

Responses

  • 200 OK
GET /api/operator/venue/highlights/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
PUT /api/operator/venue/highlights/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

SaveHighlightRequest
FieldTypeRequiredNullableConstraintsDescription
statusHighlightStatusYes–one of: Draft, PublishedDraft or published.
titlestringYes––The headline.
textstringYesYes–Optional short text.
imageUrlstringYesYes–The card's image (required); an upload through POST /api/operator/venue/menus/media returns one.
linkKindHighlightLinkKindYes–one of: None, MenuItem, Event, VoucherProduct, ExternalWhat the card links to.
linkTargetstringYesYes–Required for every kind but None; refused with None.
sortOrderinteger (int32)Yes––Manual order among highlights (0 to 999).
visibleFromstring (date)YesYes–First venue-local day the card shows; null means no lower bound.
visibleTostring (date)YesYes–Last venue-local day the card shows; null means no upper bound.

Responses

  • 200 OK
DELETE /api/operator/venue/highlights/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/operator/venue/media

Needs an Auth0 bearer token.

Request body multipart/form-data

string (binary)

Responses

  • 200 OK
DELETE /api/operator/venue/media/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstringYes––

Responses

  • 200 OK
GET /api/operator/venue/menus

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/menus

Needs an Auth0 bearer token.

Request body application/json

SaveMenusRequest
FieldTypeRequiredNullableConstraintsDescription
menusarray of SaveMenuDtoYes––
menus[].idstringYesYes–
menus[].namestringYes––
menus[].descriptionstringYes––
menus[].kindMenuKindYes–one of: Food, DrinksWhether a menu serves food or drinks. Whether a resource may order food is a per-resource setting (BookableResource.AllowsFoodOrdering in BookDinePlay.Domain), defaulted by resource type via MenuAvailability.DefaultAllowsFoodOrdering and overridable by the venue operator. Those are named rather than cross-referenced because this assembly does not reference Domain.
menus[].groupsarray of SaveMenuGroupDtoYes––
menus[].groups[].namestringYes––
menus[].groups[].descriptionstringYesYes–
menus[].groups[].itemsarray of SaveMenuItemDtoYes––
menus[].groups[].items[].namestringYes––
menus[].groups[].items[].descriptionstringYes––
menus[].groups[].items[].pricenumber (double)Yes–pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
menus[].groups[].items[].taxRatenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
menus[].groups[].items[].tagsarray of stringYes––
menus[].groups[].items[].imageUrlstringYesYes–
menus[].groups[].items[].idstringNoYes–

Responses

  • 200 OK
POST /api/operator/venue/menus/media

Needs an Auth0 bearer token.

Request body multipart/form-data

string (binary)

Responses

  • 200 OK
GET /api/operator/venue/messages

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/messages/{threadId}/reply

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
threadIdpathstring (uuid)Yes––

Request body application/json

OperatorReplyRequest
FieldTypeRequiredNullableConstraintsDescription
bodystringYes––

Responses

  • 200 OK
GET /api/operator/venue/notification-preferences

Operation: OperatorMyNotificationPreferences

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/notification-preferences

Operation: OperatorSaveMyNotificationPreferences

Needs an Auth0 bearer token.

Request body application/json

SaveStaffNotificationPreferencesRequest
FieldTypeRequiredNullableConstraintsDescription
newBookingsbooleanYes––
bookingRequestsbooleanYes––
cancellationsbooleanYes––
guestMessagesbooleanYes––
allOrdersbooleanYes––
orderStationIdsarray of string (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/opening-hours

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/opening-hours

Needs an Auth0 bearer token.

Request body application/json

OperatorOpeningHoursDto
FieldTypeRequiredNullableConstraintsDescription
regulararray of OperatorDayHoursDtoYes––
regular[].daystringYes––
regular[].isClosedbooleanYes––
regular[].opensstringYesYes–
regular[].closesstringYesYes–
regular[].breaksarray of HoursBreakDtoYes––
regular[].breaks[].startstringYes––
regular[].breaks[].endstringYes––
specialarray of OperatorSpecialHoursDtoYes––
special[].datestringYes––
special[].isClosedbooleanYes––
special[].opensstringYesYes–
special[].closesstringYesYes–
special[].notestringYesYes–
special[].breaksarray of HoursBreakDtoYes––
special[].breaks[].startstringYes––
special[].breaks[].endstringYes––

Responses

  • 200 OK
GET /api/operator/venue/orders

Needs an Auth0 bearer token.

Responses

  • 200 OK
GET /api/operator/venue/payouts

Operation: GetPayoutStatus

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/payouts/onboarding-link

Operation: StartPayoutOnboarding

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/payouts/refresh

Operation: RefreshPayoutStatus

Needs an Auth0 bearer token.

Responses

  • 200 OK
GET /api/operator/venue/qr-codes

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/qr-codes/generate

Needs an Auth0 bearer token.

Responses

  • 200 OK
DELETE /api/operator/venue/qr-codes/{code}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
codepathstringYes––

Responses

  • 200 OK
POST /api/operator/venue/qr-codes/{code}/regenerate

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
codepathstringYes––

Responses

  • 200 OK
GET /api/operator/venue/request-settings

Operation: OperatorRequestSettings

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/request-settings

Operation: OperatorUpdateRequestSettings

Needs an Auth0 bearer token.

Request body application/json

ReservationRequestSettingsDto
FieldTypeRequiredNullableConstraintsDescription
groupRequestThresholdinteger (int32)NoYes–From this many persons a guest booking is a request (2 to 200); null switches the group rule off. Null means the same thing on every path that reads it, so there is nothing to preserve.
holdMinutesinteger (int32)No–default 1440How long an unanswered request keeps its tables before it expires, in whole quarter hours from 30 minutes to 7 days. Default 1440 (24 hours).
childrenSlotsarray of HighValueSlotDtoNoYes–The windows in which a booking with children is a request; empty switches the rule off. At most 20.
childrenSlots[].namestringYesYes–A label for the console ("Friday and Saturday evening"); at most 80 characters.
childrenSlots[].daysarray of DayOfWeekYes–one of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayThe weekdays it applies to; at least one, no repeats.
childrenSlots[].fromstringYes––First start time that is inside the window, HH:mm venue-local.
childrenSlots[].tostringYes––First start time that is outside it again, HH:mm. A To that is not after From runs past midnight (22:00 to 02:00).
childrenSlots[].validFromstringNoYes–First date the window is in force, yyyy-MM-dd, inclusive; null = from the start.
childrenSlots[].validTostringNoYes–Last date it is in force, inclusive; null = without end.

Responses

  • 200 OK
GET /api/operator/venue/requests

Operation: OperatorReservationRequests

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/requests/{reference}/approve

Operation: OperatorApproveReservationRequest

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
referencepathstringYes––

Request body application/json

ApproveReservationRequestRequest
FieldTypeRequiredNullableConstraintsDescription
depositAmountnumber (double)NoYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Attaches a deposit the guest pays online to secure the booking (in the venue's payment currency); null (or omitted) confirms the booking right away. A positive amount keeps it pending until it is paid, through the same deposit flow as any booking.

Responses

  • 200 OK
POST /api/operator/venue/requests/{reference}/decline

Operation: OperatorDeclineReservationRequest

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
referencepathstringYes––

Request body application/json

DeclineReservationRequestRequest
FieldTypeRequiredNullableConstraintsDescription
messagestringNoYes–An optional note to the guest, at most 500 characters, quoted in the decline e-mail.

Responses

  • 200 OK
GET /api/operator/venue/reservations

Operation: OperatorReservations

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
datequerystringYes––

Responses

  • 200 OK
POST /api/operator/venue/reservations

Operation: OperatorCreateReservation

Needs an Auth0 bearer token.

Request body application/json

CreateOperatorReservationRequest
FieldTypeRequiredNullableConstraintsDescription
resourceTypeBookableResourceTypeYes–one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ.
resourceIdstringNoYes–Optional specific resource id. When omitted the service picks the first available resource of the type.
datestringYes––Venue-local date, "yyyy-MM-dd".
startstringYes––Venue-local start time, "HH:mm".
endstringNoYes–Optional venue-local end time, "HH:mm". Defaults to the resource slot length.
partySizeinteger (int32)Yes–min 1
max 200
gamesinteger (int32)NoYesmin 1
max 10
How many games to book, for resources priced per game. Defaults to 1 when omitted.
customerNamestringYes–length 2–120
emailstringNoYesmax 256 charactersOptional here — a guest booked by phone may give no email at all. At least one of string? CreateOperatorReservationRequest.Email or string? CreateOperatorReservationRequest.Phone must be present; see IEnumerable<ValidationResult> CreateOperatorReservationRequest.Validate(ValidationContext validationContext).
phonestringNoYeslength 3–40Optional. 3–40 characters when supplied; blank is treated as not supplied.
notesstringNoYesmax 500 characters
extrasarray of ExtraSelectionDtoNoYes–Optional extras to add to the booking, e.g. shoe rental.
extras[].extraIdstringYes––
extras[].quantityinteger (int32)Yes–min 1
max 100
durationMinutesinteger (int32)NoYesmin 15
max 1440
Requested booking length in minutes. When omitted the venue's default for the resource type applies. Must be a duration the venue offers for that type, and the whole booking must fit inside the venue's opening hours.
languagestringNoYes–The guest's language ("en"/"de") for the confirmation email, as the guest stated it on the phone. Optional — when omitted, the venue's own preferred language is used instead of whatever language the operator's own console happens to be in, which says nothing about which language the guest speaks.
childreninteger (int32)NoYesmin 0
max 199
How many of int CreateOperatorReservationRequest.PartySize are children (issue #554). int CreateOperatorReservationRequest.PartySize stays the total head count and the only capacity input, so adults are PartySize - Children; at least one adult must remain. Omitted or null means no children. Refused while the venue has switched the "ask for children" setting off.
highChairsinteger (int32)NoYesmin 0
max 199
High chairs reserved (issue #555): 0 up to int? CreateOperatorReservationRequest.Children, within the venue's inventory for the window. Omitted or null means none.

Responses

  • 200 OK
GET /api/operator/venue/reservations/{reference}

Operation: OperatorGetReservation

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
referencepathstringYes––

Responses

  • 200 OK
PUT /api/operator/venue/reservations/{reference}

Operation: OperatorUpdateReservation

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
referencepathstringYes––

Request body application/json

UpdateOperatorReservationRequest
FieldTypeRequiredNullableConstraintsDescription
resourceTypeBookableResourceTypeYes–one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ.
resourceIdstringNoYes–Optional. When omitted, the reservation keeps its current resource rather than being silently reassigned to whichever other resource of the type happens to be free.
datestringYes––Venue-local date, "yyyy-MM-dd".
startstringYes––Venue-local start time, "HH:mm".
endstringNoYes–
partySizeinteger (int32)Yes–min 1
max 200
gamesinteger (int32)NoYesmin 1
max 10
customerNamestringYes–length 2–120
emailstringNoYesmax 256 charactersOptional; at least one of string? UpdateOperatorReservationRequest.Email or string? UpdateOperatorReservationRequest.Phone is required — see IEnumerable<ValidationResult> UpdateOperatorReservationRequest.Validate(ValidationContext validationContext).
phonestringNoYeslength 3–40
notesstringNoYesmax 500 characters
extrasarray of ExtraSelectionDtoNoYes–
extras[].extraIdstringYes––
extras[].quantityinteger (int32)Yes–min 1
max 100
durationMinutesinteger (int32)NoYesmin 15
max 1440
childreninteger (int32)NoYesmin 0
max 199
How many of int UpdateOperatorReservationRequest.PartySize are children (issue #554). int UpdateOperatorReservationRequest.PartySize stays the total head count and the only capacity input, so adults are PartySize - Children; at least one adult must remain. Null leaves the booking's current number of children untouched (clamped so one adult remains). Refused while the venue has switched the "ask for children" setting off.
highChairsinteger (int32)NoYesmin 0
max 199
High chairs reserved (issue #555). Null leaves the booking's current number untouched (clamped to its children).

Responses

  • 200 OK
POST /api/operator/venue/reservations/{reference}/assign-table

Operation: OperatorAssignReservationTable

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
referencepathstringYes––

Request body application/json

AssignReservationTableRequest
FieldTypeRequiredNullableConstraintsDescription
resourceIdstringYes––The id of the restaurant table to seat the booking at.

Responses

  • 200 OK
POST /api/operator/venue/reservations/{reference}/refund

Operation: OperatorRefundReservationDeposit

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
referencepathstringYes––

Responses

  • 200 OK
POST /api/operator/venue/reservations/{reference}/status

Operation: OperatorSetReservationStatus

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
referencepathstringYes––

Request body application/json

SetReservationStatusRequest
FieldTypeRequiredNullableConstraintsDescription
statusReservationStatusYes–one of: Pending, Confirmed, Cancelled, Completed, NoShow, PaidButUnavailableLifecycle status of a reservation.

Responses

  • 200 OK
GET /api/operator/venue/resource-blocks

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/resource-blocks

Needs an Auth0 bearer token.

Request body application/json

SaveResourceBlockRequest
FieldTypeRequiredNullableConstraintsDescription
resourceIdstringNoYes–Code of the resource to block (required on create).
fromstringNoYes–First blocked date ("yyyy-MM-dd"), or null for no start bound.
tostringNoYes–Last blocked date ("yyyy-MM-dd"), or null for no end bound.
daysarray of DayOfWeekNoYesone of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayWeekdays; null or empty means every day.
startTimestringNoYes–Start of the daily window ("HH:mm"); give both times or neither.
endTimestringNoYes–End of the daily window ("HH:mm"); at or before the start it runs past midnight.
seatsinteger (int32)NoYes–Seats to block on a seat-sold resource; null blocks the whole resource.
notestringNoYes–The operator's own reminder (at most 200 characters).

Responses

  • 200 OK
PUT /api/operator/venue/resource-blocks/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

SaveResourceBlockRequest
FieldTypeRequiredNullableConstraintsDescription
resourceIdstringNoYes–Code of the resource to block (required on create).
fromstringNoYes–First blocked date ("yyyy-MM-dd"), or null for no start bound.
tostringNoYes–Last blocked date ("yyyy-MM-dd"), or null for no end bound.
daysarray of DayOfWeekNoYesone of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayWeekdays; null or empty means every day.
startTimestringNoYes–Start of the daily window ("HH:mm"); give both times or neither.
endTimestringNoYes–End of the daily window ("HH:mm"); at or before the start it runs past midnight.
seatsinteger (int32)NoYes–Seats to block on a seat-sold resource; null blocks the whole resource.
notestringNoYes–The operator's own reminder (at most 200 characters).

Responses

  • 200 OK
DELETE /api/operator/venue/resource-blocks/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/resource-groups

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/resource-groups

Needs an Auth0 bearer token.

Request body application/json

SaveResourceGroupRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––
descriptionstringYes––

Responses

  • 200 OK
PUT /api/operator/venue/resource-groups/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

UpdateResourceGroupRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––
descriptionstringYes––
ordinalinteger (int32)Yes––

Responses

  • 200 OK
DELETE /api/operator/venue/resource-groups/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/resources

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/resources

Needs an Auth0 bearer token.

Request body application/json

SaveResourceRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––
typeBookableResourceTypeYes–one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ.
capacityinteger (int32)Yes––
descriptionstringYes––
slotDurationMinutesinteger (int32)YesYes–Booking slot duration in minutes, or null to inherit the venue's default for the type. Unlike bool? SaveResourceRequest.AllowsFoodOrdering and bool? SaveResourceRequest.SeatSold, null here is a fully-specified, always-applied value ("inherit the policy") on both create and update — there is no create/update ambiguity to resolve, so this field is applied unconditionally.
pricingResourcePricingDtoYes––Pricing details for a bookable resource.
pricing.modelPricingModelYes–one of: Free, PerHour, PerGame, PerSession, FixedFee, Deposit, MinimumSpendHow a bookable resource is priced.
pricing.amountnumber (double)Yes–pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.currencystringYes––
pricing.depositAmountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.minimumSpendnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.unitLabelstringYes––
pricing.childAmountnumber (double)NoYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$What a child pays where the price scales with people (PricingModel.PerGame), in Currency (#556): 0 means children are free, null that a child pays Amount like an adult. Ignored for the models that charge once per booking. Defaulted so pre-existing payloads still bind.
pricing.depositPerPersonbooleanNo–default falseWhether DepositAmount is charged per person instead of once per booking (#556). False for every pre-existing resource and payload.
pricing.childDepositAmountnumber (double)NoYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$What a child pays towards a per-person deposit (#556): 0 means children are free, null that a child pays DepositAmount. Only meaningful with DepositPerPerson.
allowsFoodOrderingbooleanYesYes–
seatSoldbooleanNoYes–Whether the resource is sold by the seat instead of booked exclusively — see bool BookableResourceDto.SeatSold.

Responses

  • 200 OK
PUT /api/operator/venue/resources/{code}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
codepathstringYes––

Request body application/json

SaveResourceRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––
typeBookableResourceTypeYes–one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ.
capacityinteger (int32)Yes––
descriptionstringYes––
slotDurationMinutesinteger (int32)YesYes–Booking slot duration in minutes, or null to inherit the venue's default for the type. Unlike bool? SaveResourceRequest.AllowsFoodOrdering and bool? SaveResourceRequest.SeatSold, null here is a fully-specified, always-applied value ("inherit the policy") on both create and update — there is no create/update ambiguity to resolve, so this field is applied unconditionally.
pricingResourcePricingDtoYes––Pricing details for a bookable resource.
pricing.modelPricingModelYes–one of: Free, PerHour, PerGame, PerSession, FixedFee, Deposit, MinimumSpendHow a bookable resource is priced.
pricing.amountnumber (double)Yes–pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.currencystringYes––
pricing.depositAmountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.minimumSpendnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.unitLabelstringYes––
pricing.childAmountnumber (double)NoYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$What a child pays where the price scales with people (PricingModel.PerGame), in Currency (#556): 0 means children are free, null that a child pays Amount like an adult. Ignored for the models that charge once per booking. Defaulted so pre-existing payloads still bind.
pricing.depositPerPersonbooleanNo–default falseWhether DepositAmount is charged per person instead of once per booking (#556). False for every pre-existing resource and payload.
pricing.childDepositAmountnumber (double)NoYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$What a child pays towards a per-person deposit (#556): 0 means children are free, null that a child pays DepositAmount. Only meaningful with DepositPerPerson.
allowsFoodOrderingbooleanYesYes–
seatSoldbooleanNoYes–Whether the resource is sold by the seat instead of booked exclusively — see bool BookableResourceDto.SeatSold.

Responses

  • 200 OK
DELETE /api/operator/venue/resources/{code}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
codepathstringYes––

Responses

  • 200 OK
PUT /api/operator/venue/resources/{code}/group

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
codepathstringYes––

Request body application/json

AssignResourceGroupRequest
FieldTypeRequiredNullableConstraintsDescription
resourceGroupIdstring (uuid)YesYes–

Responses

  • 200 OK
GET /api/operator/venue/shifts

Operation: OperatorShifts

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
fromquerystring (date)No––
toquerystring (date)No––
memberIdquerystring (uuid)No––

Responses

  • 200 OK
POST /api/operator/venue/shifts

Operation: OperatorCreateShift

Needs an Auth0 bearer token.

Request body application/json

SaveStaffShiftRequest
FieldTypeRequiredNullableConstraintsDescription
memberIdstring (uuid)Yes––
datestring (date)Yes––
startTimestring (time)Yes––
endTimestring (time)Yes––
notestringNoYes–

Responses

  • 200 OK
GET /api/operator/venue/shifts/mine

Operation: OperatorMyShifts

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/shifts/{id}

Operation: OperatorUpdateShift

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

SaveStaffShiftRequest
FieldTypeRequiredNullableConstraintsDescription
memberIdstring (uuid)Yes––
datestring (date)Yes––
startTimestring (time)Yes––
endTimestring (time)Yes––
notestringNoYes–

Responses

  • 200 OK
DELETE /api/operator/venue/shifts/{id}

Operation: OperatorDeleteShift

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/specials

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
archivedquerybooleanNo–default false

Responses

  • 200 OK
POST /api/operator/venue/specials

Needs an Auth0 bearer token.

Request body application/json

SaveSpecialRequest
FieldTypeRequiredNullableConstraintsDescription
kindSpecialKindYes–one of: Dish, MenuItemDish or a discount on a menu item.
statusSpecialStatusYes–one of: Draft, Published, ArchivedDraft, live or archived.
titlestringYes––The headline.
descriptionstringYesYes–Optional description.
imageUrlstringYesYes–The special's own image.
pricenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price.
taxRatenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The tax rate; null means none recorded (a menu-item special inherits the item's).
menuItemIdstringYesYes–The referenced menu item's id, if any.
sortOrderinteger (int32)Yes––Manual order among specials.
startsOnstring (date)YesYes–First day it runs; null means no lower bound.
endsOnstring (date)YesYes–Last day it runs; null means no upper bound.
weekdaysarray of DayOfWeekYesYesone of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayDays of the week it runs on; null or empty means every day.
windowStartstring (time)YesYes–Start of the daily window; null means all day. One side alone is refused.
windowEndstring (time)YesYes–End of the daily window; null means all day. One side alone is refused.

Responses

  • 200 OK
GET /api/operator/venue/specials/days

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
datequerystringNo––
daysquerystringNo––

Responses

  • 200 OK
POST /api/operator/venue/specials/preview

Needs an Auth0 bearer token.

Request body application/json

SpecialsPreviewRequest
FieldTypeRequiredNullableConstraintsDescription
datestring (date)Yes––The day to preview.
draftSaveSpecialRequestNoYes–Body of POST and PUT /api/operator/venue/specials. A full replace: every member is applied as sent, an omitted status binds Draft (unpublishing the special) and an omitted kind binds Dish, so always send both. Null on the optional members is a complete answer, never "leave the stored value".
draft.kindSpecialKindYes–one of: Dish, MenuItemDish or a discount on a menu item.
draft.statusSpecialStatusYes–one of: Draft, Published, ArchivedDraft, live or archived.
draft.titlestringYes––The headline.
draft.descriptionstringYesYes–Optional description.
draft.imageUrlstringYesYes–The special's own image.
draft.pricenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price.
draft.taxRatenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The tax rate; null means none recorded (a menu-item special inherits the item's).
draft.menuItemIdstringYesYes–The referenced menu item's id, if any.
draft.sortOrderinteger (int32)Yes––Manual order among specials.
draft.startsOnstring (date)YesYes–First day it runs; null means no lower bound.
draft.endsOnstring (date)YesYes–Last day it runs; null means no upper bound.
draft.weekdaysarray of DayOfWeekYesYesone of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayDays of the week it runs on; null or empty means every day.
draft.windowStartstring (time)YesYes–Start of the daily window; null means all day. One side alone is refused.
draft.windowEndstring (time)YesYes–End of the daily window; null means all day. One side alone is refused.
draftIdstring (uuid)NoYes–The id of a stored special the draft replaces.

Responses

  • 200 OK
GET /api/operator/venue/specials/print

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
datequerystringNo––
daysquerystringNo––
paperquerystringNo––
langquerystringNo––

Responses

  • 200 OK
GET /api/operator/venue/specials/settings

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/specials/settings

Needs an Auth0 bearer token.

Request body application/json

any

Responses

  • 200 OK
GET /api/operator/venue/specials/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
PUT /api/operator/venue/specials/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

SaveSpecialRequest
FieldTypeRequiredNullableConstraintsDescription
kindSpecialKindYes–one of: Dish, MenuItemDish or a discount on a menu item.
statusSpecialStatusYes–one of: Draft, Published, ArchivedDraft, live or archived.
titlestringYes––The headline.
descriptionstringYesYes–Optional description.
imageUrlstringYesYes–The special's own image.
pricenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price.
taxRatenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The tax rate; null means none recorded (a menu-item special inherits the item's).
menuItemIdstringYesYes–The referenced menu item's id, if any.
sortOrderinteger (int32)Yes––Manual order among specials.
startsOnstring (date)YesYes–First day it runs; null means no lower bound.
endsOnstring (date)YesYes–Last day it runs; null means no upper bound.
weekdaysarray of DayOfWeekYesYesone of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayDays of the week it runs on; null or empty means every day.
windowStartstring (time)YesYes–Start of the daily window; null means all day. One side alone is refused.
windowEndstring (time)YesYes–End of the daily window; null means all day. One side alone is refused.

Responses

  • 200 OK
DELETE /api/operator/venue/specials/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/staff-access-grants

Operation: OperatorStaffAccessGrants

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
memberIdquerystring (uuid)No––

Responses

  • 200 OK
POST /api/operator/venue/staff-access-grants

Operation: OperatorGrantStaffAccess

Needs an Auth0 bearer token.

Request body application/json

GrantStaffAccessRequest
FieldTypeRequiredNullableConstraintsDescription
memberIdstring (uuid)Yes––
minutesinteger (int32)Yes––
reasonstringNoYes–

Responses

  • 200 OK
DELETE /api/operator/venue/staff-access-grants/{id}

Operation: OperatorRevokeStaffAccess

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/staff-access-policy

Operation: OperatorStaffAccessPolicy

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/staff-access-policy

Operation: OperatorSaveStaffAccessPolicy

Needs an Auth0 bearer token.

Request body application/json

SaveStaffAccessPolicyRequest
FieldTypeRequiredNullableConstraintsDescription
bufferBeforeMinutesinteger (int32)Yes––
bufferAfterMinutesinteger (int32)Yes––

Responses

  • 200 OK
PUT /api/operator/venue/station-routes

Operation: OperatorSaveStationRoutes

Needs an Auth0 bearer token.

Request body application/json

SaveStationRoutesRequest
FieldTypeRequiredNullableConstraintsDescription
routesarray of StationRouteDtoYes––
routes[].stationIdstring (uuid)Yes––
routes[].menuIdstringYes––
routes[].groupNamestringNoYes–
routes[].menuItemIdstringNoYes–

Responses

  • 200 OK
GET /api/operator/venue/stations

Operation: OperatorStations

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/stations

Operation: OperatorCreateStation

Needs an Auth0 bearer token.

Request body application/json

SaveVenueStationRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––1 to 40 characters, unique at the venue (case-insensitive).
sortOrderinteger (int32)No–default 0Where the station is listed; lower first.

Responses

  • 200 OK
PUT /api/operator/venue/stations/{id}

Operation: OperatorUpdateStation

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

SaveVenueStationRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––1 to 40 characters, unique at the venue (case-insensitive).
sortOrderinteger (int32)No–default 0Where the station is listed; lower first.

Responses

  • 200 OK
DELETE /api/operator/venue/stations/{id}

Operation: OperatorDeleteStation

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/table-merges

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venue/table-merges

Needs an Auth0 bearer token.

Request body application/json

SaveTableMergeOptionRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––
resourceCodesarray of stringYes––
capacityinteger (int32)Yes––

Responses

  • 200 OK
PUT /api/operator/venue/table-merges/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

SaveTableMergeOptionRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––
resourceCodesarray of stringYes––
capacityinteger (int32)Yes––

Responses

  • 200 OK
DELETE /api/operator/venue/table-merges/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/team/{memberId}/notification-preferences

Operation: OperatorMemberNotificationPreferences

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
memberIdpathstring (uuid)Yes––

Responses

  • 200 OK
PUT /api/operator/venue/team/{memberId}/notification-preferences

Operation: OperatorSaveMemberNotificationPreferences

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
memberIdpathstring (uuid)Yes––

Request body application/json

SaveStaffNotificationPreferencesRequest
FieldTypeRequiredNullableConstraintsDescription
newBookingsbooleanYes––
bookingRequestsbooleanYes––
cancellationsbooleanYes––
guestMessagesbooleanYes––
allOrdersbooleanYes––
orderStationIdsarray of string (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venue/unassigned-bookings

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/unassigned-bookings

Needs an Auth0 bearer token.

Request body application/json

any

Responses

  • 200 OK
GET /api/operator/venue/voucher-settings

Needs an Auth0 bearer token.

Responses

  • 200 OK
PUT /api/operator/venue/voucher-settings

Needs an Auth0 bearer token.

Request body application/json

SaveVoucherSettingsRequest
FieldTypeRequiredNullableConstraintsDescription
onlineSaleEnabledbooleanYes––
validityVoucherValidityDtoYesYes–How long the venue's vouchers are valid. Exactly the member Mode needs is set: Months (1–360), FixedDate (yyyy-MM-dd) or Years (0–30, the year-end rule: 31 December of the issue year plus that many years).
validity.modeVoucherValidityModeYes–one of: Months, FixedDate, YearEndAfterYearsHow a venue's voucher validity rule computes an expiry date from the issue date.
validity.monthsinteger (int32)YesYes–
validity.fixedDatestringYesYes–
validity.yearsinteger (int32)YesYes–
productsarray of VoucherProductDtoYes––
products[].idstringYesYes–Null for a new product, which the server mints an id for; a known id is preserved.
products[].kindVoucherKindYes–one of: Amount, Percentage, ItemWhat a voucher is worth, and so how it redeems.
products[].titleEnstringYes––
products[].titleDestringYesYes–
products[].vatClassificationVoucherVatClassificationYesYesone of: SinglePurpose, MultiPurpose
products[].amountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$VoucherKind.Amount with a fixed value: the value and the sale price.
products[].customAmountbooleanYes––VoucherKind.Amount: the buyer picks the value within MinAmount–MaxAmount.
products[].minAmountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
products[].maxAmountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
products[].percentagenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
products[].maxDiscountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
products[].menuItemIdstringYesYes–VoucherKind.Item: the menu item's stable id; it must exist in the venue's menus.
products[].menuItemNamestringYesYes–Ignored on save: the server snapshots the menu item's current name.
products[].salePricenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The online sale price of a percentage or item product; required when it is sold online.
products[].sellOnlinebooleanYes––
products[].activebooleanYes––
products[].sortOrderinteger (int32)Yes––
termsEnstringYesYes–
termsDestringYesYes–

Responses

  • 200 OK
GET /api/operator/venue/vouchers

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
searchquerystringNo––
statusquerystringNo––
pagequeryinteger (int32)No––
pageSizequeryinteger (int32)No––

Responses

  • 200 OK
POST /api/operator/venue/vouchers

Needs an Auth0 bearer token.

Request body application/json

IssueVoucherRequest
FieldTypeRequiredNullableConstraintsDescription
productIdstringYesYes–Issue from one of the venue's products; its kind, value and VAT classification are used and the ad-hoc members below are ignored. Null issues ad hoc from Kind.
kindVoucherKindYesYesone of: Amount, Percentage, ItemWhat a voucher is worth, and so how it redeems.
amountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Ad hoc VoucherKind.Amount, or the value of a custom-amount product.
percentagenumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
maxDiscountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
menuItemIdstringYesYes–Ad hoc VoucherKind.Item: the menu item's stable id.
vatClassificationVoucherVatClassificationYesYesone of: SinglePurpose, MultiPurpose
paymentVoucherManualPaymentYes–one of: Cash, CardAtTill, NotPaidHow the voucher was paid at the venue; VoucherManualPayment.NotPaid for a promo or goodwill voucher.
pricePaidnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$What was taken at the till; required unless Payment is VoucherManualPayment.NotPaid.
expiresOnstringYesYes–Overrides the venue's validity rule (yyyy-MM-dd). A paid voucher must be valid for at least one year.
recipientNamestringYesYes–
recipientEmailstringYesYes–
giftMessagestringYesYes–
languagestringYesYes–"en" or "de": the language of the terms snapshot. Defaults to the venue's.

Responses

  • 200 OK
POST /api/operator/venue/vouchers/lookup

Needs an Auth0 bearer token.

Request body application/json

VoucherLookupRequest
FieldTypeRequiredNullableConstraintsDescription
codestringYes––

Responses

  • 200 OK
GET /api/operator/venue/vouchers/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
PUT /api/operator/venue/vouchers/{id}/expiry

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

ChangeVoucherExpiryRequest
FieldTypeRequiredNullableConstraintsDescription
expiresOnstringYes––
reasonstringYes––

Responses

  • 200 OK
GET /api/operator/venue/vouchers/{id}/printable

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/operator/venue/vouchers/{id}/redemptions

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

RedeemVoucherRequest
FieldTypeRequiredNullableConstraintsDescription
amountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
billTotalnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
tabSessionIdstring (uuid)YesYes–Apply to this open QR ordering tab (the operator board's Guid? TableTabDto.SessionId): the redemption is credited against the tab, so its amount due and the voucher stay consistent. Null redeems against a bill outside BookDinePlay.
tabLineIndexinteger (int32)YesYes–Item vouchers on a tab: the zero-based index into the tab's lines (IReadOnlyList<TabLineDto>? TableTabDto.Lines / IReadOnlyList<TabLineDto> TableSessionResponse.Tab).
billReferencestringYesYes–Optional free text from staff (at most 80 characters), e.g. the till receipt number.
tabLineItemNamestringNoYes–Item vouchers on a tab: the item name of the line staff picked, as they saw it. When given, a line at TabLineIndex with another name is refused rather than credited — the tab may have changed (an order cancelled) since the screen loaded.

Responses

  • 200 OK
POST /api/operator/venue/vouchers/{id}/redemptions/{transactionId}/reverse

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––
transactionIdpathstring (uuid)Yes––

Request body application/json

ReverseVoucherRedemptionRequest
FieldTypeRequiredNullableConstraintsDescription
reasonstringYesYes–

Responses

  • 200 OK
POST /api/operator/venue/vouchers/{id}/refund

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/operator/venue/vouchers/{id}/resend

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
POST /api/operator/venue/vouchers/{id}/void

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

VoidVoucherRequest
FieldTypeRequiredNullableConstraintsDescription
reasonstringYes––

Responses

  • 200 OK
POST /api/operator/venue/zones

Needs an Auth0 bearer token.

Request body application/json

SaveZoneRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––

Responses

  • 200 OK
PUT /api/operator/venue/zones/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Request body application/json

UpdateZoneRequest
FieldTypeRequiredNullableConstraintsDescription
namestringYes––
ordinalinteger (int32)Yes––

Responses

  • 200 OK
DELETE /api/operator/venue/zones/{id}

Needs an Auth0 bearer token.

Parameters

NameInTypeRequiredNullableConstraints
idpathstring (uuid)Yes––

Responses

  • 200 OK
GET /api/operator/venues

Operation: OperatorVenues

Needs an Auth0 bearer token.

Responses

  • 200 OK
POST /api/operator/venues

Needs an Auth0 bearer token.

Request body application/json

CreateVenueRequest
FieldTypeRequiredNullableConstraintsDescription
slugstringYes––
namestringYes––
taglinestringYes––
descriptionstringYes––
citystringYes––
countrystringYes––
timezonestringYes––
businessProfileBusinessProfileDtoYes––Venue business profile (address + contact), for the operator's edit surface.
businessProfile.legalNamestringYes––
businessProfile.addressLine1stringYes––
businessProfile.addressLine2stringYesYes–
businessProfile.citystringYes––
businessProfile.postalCodestringYes––
businessProfile.countrystringYes––
businessProfile.phonestringYes––
businessProfile.emailstringYes––
businessProfile.websitestringYesYes–
paymentPolicyPaymentPolicyDtoYes––Venue payment policy, for the operator's edit surface.
paymentPolicy.paymentsEnabledbooleanYes––
paymentPolicy.depositsEnabledbooleanYes––
paymentPolicy.currencystringYes––
paymentPolicy.defaultDepositAmountnumber (double)YesYespattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
preferredLanguagestringNo–default en

Responses

  • 200 OK

Problem types

Every problem type of the form https://bookdineplay.com/docs/api/errors/<reason> lands on the section of the errors page with that name.