Sign in to see your venue's slug and publishable key in every sample.
Your account has no venue yet, so the samples keep their placeholders. Sign out
Signed in as · . Create a publishable key in the console and reload to see it here. Sign out
Signed in as · . The samples show your venue's publishable key. Sign out
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
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
query | query | string | No | – | – |
city | query | string | No | – | – |
page | query | integer (int32) | No | – | – |
pageSize | query | integer (int32) | No | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
missing-api-keyinvalid-api-keyplatform-key-requiredorigin-not-allowedapp-key-from-browserrate-limited
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}
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
GET /api/venues/{venueSlug}/availability
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
date | query | string | Yes | – | – |
partySize | query | integer (int32) | No | – | default 2 |
resourceType | query | BookableResourceType | No | – | default RestaurantTableone of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar |
durationMinutes | query | integer (int32) | No | – | – |
groupBy | query | string | No | – | – |
resourceGroup | query | string (uuid) | No | – | – |
children | query | integer (int32) | No | – | default 0 |
includePreviousNight | query | boolean | No | – | default false |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
GET /api/venues/{venueSlug}/business-info
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
GET /api/venues/{venueSlug}/floor-plan
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
GET /api/venues/{venueSlug}/menus
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
GET /api/venues/{venueSlug}/opening-hours
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
POST /api/venues/{venueSlug}/payment-intents
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
reservationReference | string | Yes | – | – | |
amount | number (double) | Yes | – | min 0.01 max 100000 pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
currency | string | Yes | – | length 3–3 | |
provider | string | No | Yes | – | Optional provider key. Only the local "fake" provider is available in the first milestone. |
voucherCode | string | No | Yes | max 64 characters | A 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:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
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
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Idempotency-Key | header | string | No | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
resourceType | BookableResourceType | Yes | – | one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The 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. |
resourceId | string | No | Yes | – | Optional specific resource id. When omitted the service picks the first available resource of the type. |
date | string | Yes | – | – | Venue-local date, "yyyy-MM-dd". |
start | string | Yes | – | – | Venue-local start time, "HH:mm". |
end | string | No | Yes | – | Optional venue-local end time, "HH:mm". Defaults to the resource slot length. |
partySize | integer (int32) | Yes | – | min 1 max 200 | |
games | integer (int32) | No | Yes | min 1 max 10 | How many games to book, for resources priced per game. Defaults to 1 when omitted. |
customerName | string | Yes | – | length 2–120 | |
email | string | Yes | – | max 256 characters | Bounded 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). |
phone | string | No | Yes | length 3–40 | Optional. 3–40 characters when supplied; blank is treated as not supplied. |
notes | string | No | Yes | max 500 characters | |
depositOptIn | boolean | No | – | – | Whether the guest opts in to an optional deposit (only offered when the venue enables deposits). |
extras | array of ExtraSelectionDto | No | Yes | – | Optional extras the guest wants added to the booking, e.g. shoe rental. |
extras[].extraId | string | Yes | – | – | |
extras[].quantity | integer (int32) | Yes | – | min 1 max 100 | |
durationMinutes | integer (int32) | No | Yes | min 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. |
children | integer (int32) | No | Yes | min 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. |
highChairs | integer (int32) | No | Yes | min 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:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
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
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
GET /api/venues/{venueSlug}/events
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
upcoming | query | boolean | No | – | default true |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
GET /api/venues/{venueSlug}/events/{eventSlug}
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
eventSlug | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
POST /api/venues/{venueSlug}/events/{eventSlug}/registrations
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
eventSlug | path | string | Yes | – | – |
Idempotency-Key | header | string | No | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
buyerName | string | Yes | – | max 120 characters | |
email | string | Yes | – | max 256 characters | |
phone | string | No | Yes | max 40 characters | Optional. Blank is treated as not supplied. |
notes | string | No | Yes | max 1000 characters | |
quantity | integer (int32) | Yes | – | min 1 max 100 | How many tickets. Must not exceed the event's maxPerRegistration or its remaining capacity. |
attendees | array of string | No | – | – | 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. |
children | integer (int32) | No | Yes | min 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:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
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
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
eventSlug | path | string | Yes | – | – |
Idempotency-Key | header | string | No | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
buyerName | string | Yes | – | max 120 characters | |
email | string | Yes | – | max 256 characters | |
phone | string | No | Yes | max 40 characters | Optional. Blank is treated as not supplied. |
notes | string | No | Yes | max 1000 characters | |
quantity | integer (int32) | Yes | – | min 1 max 100 | How many tickets. Must not exceed the event's maxPerRegistration or its remaining capacity. |
attendees | array of string | No | – | – | 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. |
successUrl | string | No | Yes | – | 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). |
cancelUrl | string | No | Yes | – | Where the guest lands if they abandon Checkout. Same rule as string? EventTicketCheckoutRequest.SuccessUrl (errors.cancelUrl on failure). |
voucherCode | string | No | Yes | max 200 characters | Optional. 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. |
children | integer (int32) | No | Yes | min 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:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
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
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
date | query | string | No | – | – |
days | query | integer (int32) | No | – | default 1 |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
POST /api/venues/{venueSlug}/vouchers/checkout
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Idempotency-Key | header | string | No | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
productId | string | Yes | – | max 32 characters | The product to buy (string VoucherOfferDto.ProductId). |
amount | number (double) | No | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | A custom-amount product only: the value to buy, within its minimum and maximum. |
buyerName | string | Yes | – | max 120 characters | |
buyerEmail | string | Yes | – | max 256 characters | Where the receipt and — without a recipient e-mail — the voucher itself are sent. |
recipientName | string | No | Yes | max 120 characters | |
recipientEmail | string | No | Yes | max 256 characters | Sends the voucher to the recipient directly (on string? StartVoucherCheckoutRequest.DeliverOn, or at once). |
giftMessage | string | No | Yes | max 500 characters | |
deliverOn | string | No | Yes | – | 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. |
language | string | No | Yes | – | "en" or "de": the voucher's and the e-mails' language. Defaults to the request's language. |
successUrl | string | No | Yes | – | 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. |
cancelUrl | string | No | Yes | – | 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:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
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
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
POST /api/event-registrations/{cancelToken}/cancel
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
cancelToken | path | string | 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.
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
token | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
token | path | string | 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}/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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
token | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
lines | array of OrderLineRequest | Yes | – | – | |
lines[].menuId | string | Yes | – | – | |
lines[].itemName | string | Yes | – | – | |
lines[].quantity | integer (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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
token | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
voucherCode | string | No | Yes | max 200 characters | A 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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
token | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.
GET /api/registrations/{cancelToken}
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
cancelToken | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.
GET /api/reservations/{cancelToken}
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
cancelToken | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.
POST /api/reservations/{cancelToken}/cancel
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
cancelToken | path | string | 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/reservations/{cancelToken}/push
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
cancelToken | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
deviceId | string | No | Yes | – | 22 base64url characters as the server minted it, or null. |
Responses
- 200 OK ·
application/json→GuestPushRegistrationResponseGuestPushRegistrationResponse Field Type Required Nullable Constraints Description enabledbooleanYes – – False when push is not configured on the server: the client shows no opt-in and the other members are null. appIdstringYes Yes – The public OneSignal App ID the SDK initialises with. externalIdstringYes Yes – 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. deviceIdstringYes Yes – 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
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
cancelToken | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
deviceId | string | 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.
GET /api/tickets/{code}
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
code | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem body; the type URL leads to its explanation. All problem types.
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
guestName | string | Yes | – | – | |
guestEmail | string | Yes | – | – | |
subject | string | Yes | – | – | |
body | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
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}
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
code | path | string | Yes | – | – |
Responses
- 200 OK ·
application/json→GuestVoucherResponseGuestVoucherResponse Field Type Required Nullable Constraints Description 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)Yes Yes pattern ^-?(?: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)Yes Yes pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The value an VoucherKind.Amount voucher was issued with. percentagenumber (double)Yes Yes pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$A VoucherKind.Percentage voucher's discount, 0.01–100. maxDiscountnumber (double)Yes Yes pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The venue's optional cap on a percentage discount, in money. itemNamestringYes Yes – An VoucherKind.Item voucher's menu item, as named at issue. expiresOnstringYes – – The last valid day, venue-local, yyyy-MM-dd.termsstringYes Yes – The venue's voucher terms as snapshotted at issue, in the voucher's language. recipientNamestringYes Yes – giftMessagestringYes Yes – 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.
GET /api/venues/{venueSlug}/highlights
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Responses
- 200 OK
Problem types
Refused with an RFC 7807 problem whose type links to its explanation:
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
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
Responses
- 200 OK
POST /api/admin/impersonate/{tenantId}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
tenantId | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
GET /api/admin/me
Needs an Auth0 bearer token.
Responses
- 200 OK
GET /api/admin/reservations
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | query | string | Yes | – | – |
date | query | string | Yes | – | – |
Responses
- 200 OK
POST /api/admin/reservations/{venueSlug}/{reference}/status
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
venueSlug | path | string | Yes | – | – |
reference | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
status | ReservationStatus | Yes | – | one of: Pending, Confirmed, Cancelled, Completed, NoShow, PaidButUnavailable | Lifecycle status of a reservation. |
Responses
- 200 OK
POST /api/admin/stripe/test-data-cleanup
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
dryRun | query | boolean | No | – | – |
Responses
- 200 OK
GET /api/admin/tenants
Needs an Auth0 bearer token.
Responses
- 200 OK
POST /api/admin/tenants
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | |
slug | string | Yes | – | – | |
plan | PlanTier | Yes | – | one of: Starter, Pro, Premium | Subscription 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}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
PUT /api/admin/tenants/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | |
plan | PlanTier | Yes | – | one of: Starter, Pro, Premium | Subscription 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. |
status | TenantStatus | Yes | – | one of: Active, Suspended, PendingBilling | Lifecycle status of a tenant account. |
billing | BillingMode | No | Yes | one of: Manual, Stripe, AppStore, GooglePlay |
Responses
- 200 OK
POST /api/admin/tenants/{id}/billing/resync
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
GET /api/admin/tenants/{id}/operators
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
POST /api/admin/tenants/{id}/operators
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
email | string | Yes | – | – | |
displayName | string | Yes | – | – | |
auth0Subject | string | Yes | – | – | 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. |
venueSlug | string | No | Yes | – | 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
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
email | string | Yes | – | – | 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. |
displayName | string | Yes | – | – | Shown in the console and the mail. |
venueSlug | string | No | Yes | – | 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. |
language | string | No | Yes | – | Optional mail language, en or de; omitted uses the tenant's UI language. |
Responses
- 200 OK
PUT /api/admin/tenants/{id}/operators/{operatorId}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
operatorId | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
displayName | string | Yes | – | – | |
auth0Subject | string | Yes | – | – |
Responses
- 200 OK
PUT /api/admin/tenants/{id}/operators/{operatorId}/venue-access
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
operatorId | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
venueSlug | string | Yes | Yes | – | 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
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
POST /api/onboarding
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
tenantName | string | Yes | – | – | |
slug | string | Yes | – | – | |
plan | PlanTier | Yes | – | one of: Starter, Pro, Premium | Subscription 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. |
email | string | Yes | – | – | |
displayName | string | Yes | – | – | |
company | CompanyProfileDto | No | Yes | – | 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.legalName | string | Yes | – | – | |
company.addressLine1 | string | Yes | – | – | |
company.addressLine2 | string | Yes | Yes | – | |
company.postalCode | string | Yes | – | – | |
company.city | string | Yes | – | – | |
company.country | string | Yes | – | – | ISO 3166-1 alpha-2 country code, e.g. "DE". |
company.vatId | string | Yes | Yes | – | Optional VAT identification number, e.g. "DE123456789"; format-checked only, never against a tax authority. |
company.billingEmail | string | Yes | – | – | |
company.contactName | string | Yes | – | – | |
interval | BillingInterval | No | – | one of: Monthly, Yearly | Monthly or yearly billing for the chosen plan. |
acceptances | array of AcceptLegalDocumentDto | No | Yes | – | 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[].kind | LegalDocumentKind | Yes | – | one of: Terms, DataProcessingAgreement | A legal document BookDinePlay publishes in numbered versions and every operator accepts at sign-up (and again when a newer version takes effect). |
acceptances[].version | string | Yes | – | – | |
acceptances[].language | string | Yes | – | – | |
uiLanguage | string | No | Yes | – | 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. |
billing | OnboardingBillingSource | No | Yes | one of: Web, AppStore, GooglePlay |
Responses
- 200 OK
GET /api/onboarding/legal-documents
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
language | query | string | No | – | – |
Responses
- 200 OK
GET /api/onboarding/slug-available
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
slug | query | string | No | – | – |
Responses
- 200 OK
GET /api/onboarding/status
Needs an Auth0 bearer token.
Responses
- 200 OK
DELETE /api/operator/account
Needs an Auth0 bearer token.
Responses
- 200 OK
GET /api/operator/billing
Needs an Auth0 bearer token.
Responses
- 200 OK
POST /api/operator/billing/app-store/transactions
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
signedTransaction | string | Yes | – | – | The JWS; empty when TransactionId is given instead. |
transactionId | string | No | Yes | – | 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
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
sessionId | string | Yes | – | – |
Responses
- 200 OK
POST /api/operator/billing/checkout-session
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
tier | PlanTier | Yes | – | one of: Starter, Pro, Premium | Subscription 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. |
interval | BillingInterval | Yes | – | one of: Monthly, Yearly | Billing cadence for a subscription. |
Responses
- 200 OK
PUT /api/operator/billing/company
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
legalName | string | Yes | – | – | |
addressLine1 | string | Yes | – | – | |
addressLine2 | string | Yes | Yes | – | |
postalCode | string | Yes | – | – | |
city | string | Yes | – | – | |
country | string | Yes | – | – | ISO 3166-1 alpha-2 country code, e.g. "DE". |
vatId | string | Yes | Yes | – | Optional VAT identification number, e.g. "DE123456789"; format-checked only, never against a tax authority. |
billingEmail | string | Yes | – | – | |
contactName | string | Yes | – | – |
Responses
- 200 OK
POST /api/operator/billing/google-play/purchases
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
purchaseToken | string | Yes | – | max 512 characters | |
productId | string | No | Yes | max 100 characters |
Responses
- 200 OK
POST /api/operator/billing/portal-session
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
intent | string | Yes | – | – | 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. |
tier | PlanTier | No | Yes | one of: Starter, Pro, Premium | Subscription 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. |
interval | BillingInterval | No | Yes | one of: Monthly, Yearly | Billing cadence for a subscription. |
Responses
- 200 OK
GET /api/operator/billing/store
Needs an Auth0 bearer token.
Responses
- 200 OK
GET /api/operator/employees
Needs an Auth0 bearer token.
Responses
- 200 OK
POST /api/operator/employees
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
email | string | Yes | – | – | |
displayName | string | Yes | – | – | |
role | EmployeeRole | Yes | – | one of: Manager, Staff | An employee's role within a venue. |
Responses
- 200 OK
POST /api/operator/employees/{id}/assignments
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
resourceId | string | Yes | – | – | |
resourceName | string | Yes | – | – | |
resourceType | BookableResourceType | Yes | – | one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The 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}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
resourceId | path | string | Yes | – | – |
Responses
- 200 OK
POST /api/operator/employees/{id}/status
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
isActive | boolean | Yes | – | – |
Responses
- 200 OK
GET /api/operator/guest-blocks
Needs an Auth0 bearer token.
Responses
- 200 OK
POST /api/operator/guest-blocks
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
email | string | Yes | Yes | – | |
phone | string | Yes | Yes | – | |
reason | string | Yes | – | – | Why (required, at most 500 characters). Kept in the log for the window. |
Responses
- 200 OK
GET /api/operator/guest-blocks/settings
Needs an Auth0 bearer token.
Responses
- 200 OK
PUT /api/operator/guest-blocks/settings
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
enabled | boolean | Yes | – | – | |
threshold | integer (int32) | Yes | – | – | |
windowMonths | integer (int32) | Yes | – | – |
Responses
- 200 OK
POST /api/operator/guest-blocks/unblock
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
guestRef | string | Yes | Yes | – | |
email | string | Yes | Yes | – | |
phone | string | Yes | Yes | – | |
reason | string | Yes | – | – | Why (required, at most 500 characters). Kept in the log for the window. |
Responses
- 200 OK
POST /api/operator/legal/acceptances
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
documents | array of AcceptLegalDocumentDto | Yes | – | – | |
documents[].kind | LegalDocumentKind | Yes | – | one of: Terms, DataProcessingAgreement | A legal document BookDinePlay publishes in numbered versions and every operator accepts at sign-up (and again when a newer version takes effect). |
documents[].version | string | Yes | – | – | |
documents[].language | string | Yes | – | – |
Responses
- 200 OK
GET /api/operator/legal/status
Needs an Auth0 bearer token.
Responses
- 200 OK
GET /api/operator/me
Needs an Auth0 bearer token.
Responses
- 200 OK
GET /api/operator/push/registration
Needs an Auth0 bearer token.
Responses
- 200 OK ·
application/json→PushRegistrationResponsePushRegistrationResponse Field Type Required Nullable Constraints Description 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. appIdstringYes Yes – The public OneSignal App ID the SDK initialises with. externalIdstringYes Yes – 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
Needs an Auth0 bearer token.
Responses
- 200 OK
POST /api/operator/team/invitations
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
email | string | Yes | – | – | |
displayName | string | Yes | – | – | |
role | TeamRole | No | – | one of: Staff, Manager, Owner | Manager or Staff (an Owner is never invited through the team). |
employeeId | string (uuid) | No | Yes | – | 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. |
language | string | No | Yes | – | The invite mail's language, en or de; the account's language when omitted. |
Responses
- 200 OK
DELETE /api/operator/team/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/team/{id}/employee
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
employeeId | string (uuid) | Yes | Yes | – |
Responses
- 200 OK
PUT /api/operator/team/{id}/role
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
role | TeamRole | Yes | – | one of: Staff, Manager, Owner | What 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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
slug | string | Yes | – | – | |
name | string | Yes | – | – | |
tagline | string | Yes | – | – | |
description | string | Yes | – | – | |
city | string | Yes | – | – | |
country | string | Yes | – | – | |
timezone | string | Yes | – | – | |
businessProfile | BusinessProfileDto | Yes | – | – | Venue business profile (address + contact), for the operator's edit surface. |
businessProfile.legalName | string | Yes | – | – | |
businessProfile.addressLine1 | string | Yes | – | – | |
businessProfile.addressLine2 | string | Yes | Yes | – | |
businessProfile.city | string | Yes | – | – | |
businessProfile.postalCode | string | Yes | – | – | |
businessProfile.country | string | Yes | – | – | |
businessProfile.phone | string | Yes | – | – | |
businessProfile.email | string | Yes | – | – | |
businessProfile.website | string | Yes | Yes | – | |
paymentPolicy | PaymentPolicyDto | Yes | – | – | Venue payment policy, for the operator's edit surface. |
paymentPolicy.paymentsEnabled | boolean | Yes | – | – | |
paymentPolicy.depositsEnabled | boolean | Yes | – | – | |
paymentPolicy.currency | string | Yes | – | – | |
paymentPolicy.defaultDepositAmount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
preferredLanguage | string | No | – | default en |
Responses
- 200 OK
PUT /api/operator/venue
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | |
tagline | string | Yes | – | – | |
description | string | Yes | – | – | |
city | string | Yes | – | – | |
country | string | Yes | – | – | |
timezone | string | Yes | – | – | |
businessProfile | BusinessProfileDto | Yes | – | – | Venue business profile (address + contact), for the operator's edit surface. |
businessProfile.legalName | string | Yes | – | – | |
businessProfile.addressLine1 | string | Yes | – | – | |
businessProfile.addressLine2 | string | Yes | Yes | – | |
businessProfile.city | string | Yes | – | – | |
businessProfile.postalCode | string | Yes | – | – | |
businessProfile.country | string | Yes | – | – | |
businessProfile.phone | string | Yes | – | – | |
businessProfile.email | string | Yes | – | – | |
businessProfile.website | string | Yes | Yes | – | |
paymentPolicy | PaymentPolicyDto | Yes | – | – | Venue payment policy, for the operator's edit surface. |
paymentPolicy.paymentsEnabled | boolean | Yes | – | – | |
paymentPolicy.depositsEnabled | boolean | Yes | – | – | |
paymentPolicy.currency | string | Yes | – | – | |
paymentPolicy.defaultDepositAmount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
preferredLanguage | string | No | – | default en |
Responses
- 200 OK
GET /api/operator/venue/allocation-settings
Needs an Auth0 bearer token.
Responses
- 200 OK
PUT /api/operator/venue/allocation-settings
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
forecastEnabled | boolean | No | Yes | – | |
lookBackWeeks | integer (int32) | No | Yes | – | |
quietThresholdPercent | integer (int32) | No | Yes | – | |
maxSpareSeats | integer (int32) | No | Yes | – | |
relaxedExtraSpareSeats | integer (int32) | No | Yes | – | |
clearMaxSpareSeats | boolean | No | – | 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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
label | string | Yes | – | – | |
type | ApiKeyType | Yes | – | one of: Publishable, Secret, App | How a key may be used, which decides both how it is stored and where it may be sent from. |
allowedOrigins | array of string | Yes | – | – | |
delivery | ApiKeyDelivery | No | – | one of: Inline, Reveal | How 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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
ticket | string | Yes | – | – |
Responses
- 200 OK
DELETE /api/operator/venue/api-keys/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (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
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
date | query | string | Yes | – | – |
partySize | query | integer (int32) | No | – | default 2 |
resourceType | query | BookableResourceType | No | – | default RestaurantTableone of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar |
durationMinutes | query | integer (int32) | No | – | – |
groupBy | query | string | No | – | – |
resourceGroup | query | string (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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
rules | array of BookingDurationRuleDto | Yes | – | – | |
rules[].type | BookableResourceType | Yes | – | one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The 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[].defaultMinutes | integer (int32) | Yes | – | – | |
rules[].minMinutes | integer (int32) | Yes | – | – | |
rules[].maxMinutes | integer (int32) | Yes | – | – | |
rules[].stepMinutes | integer (int32) | Yes | – | – | |
rules[].guestSelectable | boolean | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/booking-rules
Needs an Auth0 bearer token.
Responses
- 200 OK
PUT /api/operator/venue/booking-rules
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
rules | array of UpdateBookingRuleDto | Yes | – | – | |
rules[].resourceType | BookableResourceType | Yes | – | one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The 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[].minimumNoticeMinutes | integer (int32) | No | Yes | – | |
rules[].bufferMinutes | integer (int32) | No | Yes | – | |
rules[].minPartySize | integer (int32) | No | Yes | – | |
rules[].maxPartySize | integer (int32) | No | Yes | – |
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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
enabled | boolean | Yes | – | – | |
hoursBeforeStart | integer (int32) | Yes | – | – | |
depositRefund | ReservationDepositRefundMode | No | – | one of: NoOnlineRefund, RefundOnGuestCancel, ForfeitOnGuestCancel | What 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
Needs an Auth0 bearer token.
Responses
- 200 OK
PUT /api/operator/venue/child-rules
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
rules | array of ChildRuleDto | Yes | – | – | |
rules[].resourceType | BookableResourceType | Yes | – | one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The 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[].maxChildrenPerSlot | integer (int32) | No | Yes | – | 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[].noChildrenFrom | string | No | Yes | – | 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[].noChildrenUntil | string | No | Yes | – | 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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
title | string | Yes | Yes | – | |
slug | string | Yes | Yes | – | |
excerpt | string | Yes | Yes | – | |
descriptionMarkdown | string | Yes | Yes | – | |
imageUrl | string | Yes | Yes | – | |
imageAlt | string | Yes | Yes | – | |
date | string (date) | Yes | Yes | – | |
start | string (time) | Yes | Yes | – | |
end | string (time) | Yes | Yes | – | |
timeLabel | string | Yes | Yes | – | |
locationLabel | string | Yes | Yes | – | |
registration | OperatorEventRegistrationSettingsDto | Yes | Yes | – | 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.mode | EventRegistrationMode | Yes | – | one of: None, Free, Paid | Whether guests can register for an event, and whether a ticket costs money. |
registration.capacity | integer (int32) | Yes | Yes | – | |
registration.maxTicketsPerRegistration | integer (int32) | Yes | Yes | – | |
registration.closesAt | string (date-time) | Yes | Yes | – | |
registration.ticketPrice | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
registration.currency | string | Yes | Yes | – | |
registration.refundPolicyMode | RefundPolicyMode | No | – | one of: NoOnlineRefund, FullRefundUntil | How a Paid event's tickets may be refunded online by the guest. See BookDinePlay.Domain.Events.EventRefundPolicy. Only meaningful for EventRegistrationMode.Paid events. |
registration.refundHoursBeforeStart | integer (int32) | No | – | default 0 | |
registration.childTicketPrice | number (double) | No | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
language | string | Yes | Yes | – |
Responses
- 200 OK
POST /api/operator/venue/events/preview
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
markdown | string | Yes | Yes | – |
Responses
- 200 OK
GET /api/operator/venue/events/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/events/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
title | string | Yes | Yes | – | |
slug | string | Yes | Yes | – | |
excerpt | string | Yes | Yes | – | |
descriptionMarkdown | string | Yes | Yes | – | |
imageUrl | string | Yes | Yes | – | |
imageAlt | string | Yes | Yes | – | |
date | string (date) | Yes | Yes | – | |
start | string (time) | Yes | Yes | – | |
end | string (time) | Yes | Yes | – | |
timeLabel | string | Yes | Yes | – | |
locationLabel | string | Yes | Yes | – | |
registration | OperatorEventRegistrationSettingsDto | Yes | Yes | – | 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.mode | EventRegistrationMode | Yes | – | one of: None, Free, Paid | Whether guests can register for an event, and whether a ticket costs money. |
registration.capacity | integer (int32) | Yes | Yes | – | |
registration.maxTicketsPerRegistration | integer (int32) | Yes | Yes | – | |
registration.closesAt | string (date-time) | Yes | Yes | – | |
registration.ticketPrice | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
registration.currency | string | Yes | Yes | – | |
registration.refundPolicyMode | RefundPolicyMode | No | – | one of: NoOnlineRefund, FullRefundUntil | How a Paid event's tickets may be refunded online by the guest. See BookDinePlay.Domain.Events.EventRefundPolicy. Only meaningful for EventRegistrationMode.Paid events. |
registration.refundHoursBeforeStart | integer (int32) | No | – | default 0 | |
registration.childTicketPrice | number (double) | No | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
language | string | Yes | Yes | – |
Responses
- 200 OK
DELETE /api/operator/venue/events/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/events/{id}/cancel
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/events/{id}/check-in
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
code | string | Yes | Yes | – |
Responses
- 200 OK
POST /api/operator/venue/events/{id}/publish
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/events/{id}/registrations
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
page | query | integer (int32) | No | – | – |
pageSize | query | integer (int32) | No | – | – |
status | query | string | No | – | – |
Responses
- 200 OK
GET /api/operator/venue/events/{id}/registrations.csv
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/events/{id}/registrations/{registrationId}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
registrationId | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/events/{id}/registrations/{registrationId}/cancel
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
registrationId | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/events/{id}/registrations/{registrationId}/refund
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
registrationId | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/events/{id}/tickets/{code}/undo-check-in
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
code | path | string | Yes | – | – |
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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
extras | array of SaveExtraDto | Yes | – | – | |
extras[].id | string | Yes | Yes | – | |
extras[].name | string | Yes | – | – | |
extras[].description | string | Yes | – | – | |
extras[].price | number (double) | Yes | – | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
extras[].basis | ExtraPricingBasis | Yes | – | one of: PerPerson, PerBooking | How an extra is charged. |
extras[].appliesTo | array of BookableResourceType | Yes | – | 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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
placements | array of PlacementDto | Yes | – | – | |
placements[].code | string | Yes | – | – | |
placements[].zoneId | string (uuid) | Yes | Yes | – | |
placements[].x | number (double) | Yes | – | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ | |
placements[].y | number (double) | Yes | – | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ | |
placements[].width | number (double) | Yes | – | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ | |
placements[].height | number (double) | Yes | – | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ | |
placements[].shape | string | Yes | – | – | |
placements[].rotation | integer (int32) | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/high-chairs
Needs an Auth0 bearer token.
Responses
- 200 OK
PUT /api/operator/venue/high-chairs
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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
status | HighlightStatus | Yes | – | one of: Draft, Published | Draft or published. |
title | string | Yes | – | – | The headline. |
text | string | Yes | Yes | – | Optional short text. |
imageUrl | string | Yes | Yes | – | The card's image (required); an upload through POST /api/operator/venue/menus/media returns one. |
linkKind | HighlightLinkKind | Yes | – | one of: None, MenuItem, Event, VoucherProduct, External | What the card links to. |
linkTarget | string | Yes | Yes | – | Required for every kind but None; refused with None. |
sortOrder | integer (int32) | Yes | – | – | Manual order among highlights (0 to 999). |
visibleFrom | string (date) | Yes | Yes | – | First venue-local day the card shows; null means no lower bound. |
visibleTo | string (date) | Yes | Yes | – | 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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/highlights/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
status | HighlightStatus | Yes | – | one of: Draft, Published | Draft or published. |
title | string | Yes | – | – | The headline. |
text | string | Yes | Yes | – | Optional short text. |
imageUrl | string | Yes | Yes | – | The card's image (required); an upload through POST /api/operator/venue/menus/media returns one. |
linkKind | HighlightLinkKind | Yes | – | one of: None, MenuItem, Event, VoucherProduct, External | What the card links to. |
linkTarget | string | Yes | Yes | – | Required for every kind but None; refused with None. |
sortOrder | integer (int32) | Yes | – | – | Manual order among highlights (0 to 999). |
visibleFrom | string (date) | Yes | Yes | – | First venue-local day the card shows; null means no lower bound. |
visibleTo | string (date) | Yes | Yes | – | 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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string | Yes | – | – |
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
threadId | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
body | string | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/notification-preferences
Needs an Auth0 bearer token.
Responses
- 200 OK
PUT /api/operator/venue/notification-preferences
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
newBookings | boolean | Yes | – | – | |
bookingRequests | boolean | Yes | – | – | |
cancellations | boolean | Yes | – | – | |
guestMessages | boolean | Yes | – | – | |
allOrders | boolean | Yes | – | – | |
orderStationIds | array 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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
regular | array of OperatorDayHoursDto | Yes | – | – | |
regular[].day | string | Yes | – | – | |
regular[].isClosed | boolean | Yes | – | – | |
regular[].opens | string | Yes | Yes | – | |
regular[].closes | string | Yes | Yes | – | |
regular[].breaks | array of HoursBreakDto | Yes | – | – | |
regular[].breaks[].start | string | Yes | – | – | |
regular[].breaks[].end | string | Yes | – | – | |
special | array of OperatorSpecialHoursDto | Yes | – | – | |
special[].date | string | Yes | – | – | |
special[].isClosed | boolean | Yes | – | – | |
special[].opens | string | Yes | Yes | – | |
special[].closes | string | Yes | Yes | – | |
special[].note | string | Yes | Yes | – | |
special[].breaks | array of HoursBreakDto | Yes | – | – | |
special[].breaks[].start | string | Yes | – | – | |
special[].breaks[].end | string | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/orders
Needs an Auth0 bearer token.
Responses
- 200 OK
GET /api/operator/venue/payouts
Needs an Auth0 bearer token.
Responses
- 200 OK
POST /api/operator/venue/payouts/onboarding-link
Needs an Auth0 bearer token.
Responses
- 200 OK
POST /api/operator/venue/payouts/refresh
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
code | path | string | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/qr-codes/{code}/regenerate
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
code | path | string | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/request-settings
Needs an Auth0 bearer token.
Responses
- 200 OK
PUT /api/operator/venue/request-settings
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
groupRequestThreshold | integer (int32) | No | Yes | – | 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. |
holdMinutes | integer (int32) | No | – | default 1440 | How long an unanswered request keeps its tables before it expires, in whole quarter hours from 30 minutes to 7 days. Default 1440 (24 hours). |
childrenSlots | array of HighValueSlotDto | No | Yes | – | The windows in which a booking with children is a request; empty switches the rule off. At most 20. |
childrenSlots[].name | string | Yes | Yes | – | A label for the console ("Friday and Saturday evening"); at most 80 characters. |
childrenSlots[].days | array of DayOfWeek | Yes | – | one of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | The weekdays it applies to; at least one, no repeats. |
childrenSlots[].from | string | Yes | – | – | First start time that is inside the window, HH:mm venue-local. |
childrenSlots[].to | string | Yes | – | – | 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[].validFrom | string | No | Yes | – | First date the window is in force, yyyy-MM-dd, inclusive; null = from the start. |
childrenSlots[].validTo | string | No | Yes | – | Last date it is in force, inclusive; null = without end. |
Responses
- 200 OK
GET /api/operator/venue/requests
Needs an Auth0 bearer token.
Responses
- 200 OK
POST /api/operator/venue/requests/{reference}/approve
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
reference | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
depositAmount | number (double) | No | Yes | pattern ^-?(?: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
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
reference | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
message | string | No | Yes | – | An optional note to the guest, at most 500 characters, quoted in the decline e-mail. |
Responses
- 200 OK
GET /api/operator/venue/reservations
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
date | query | string | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/reservations
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
resourceType | BookableResourceType | Yes | – | one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The 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. |
resourceId | string | No | Yes | – | Optional specific resource id. When omitted the service picks the first available resource of the type. |
date | string | Yes | – | – | Venue-local date, "yyyy-MM-dd". |
start | string | Yes | – | – | Venue-local start time, "HH:mm". |
end | string | No | Yes | – | Optional venue-local end time, "HH:mm". Defaults to the resource slot length. |
partySize | integer (int32) | Yes | – | min 1 max 200 | |
games | integer (int32) | No | Yes | min 1 max 10 | How many games to book, for resources priced per game. Defaults to 1 when omitted. |
customerName | string | Yes | – | length 2–120 | |
email | string | No | Yes | max 256 characters | Optional 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). |
phone | string | No | Yes | length 3–40 | Optional. 3–40 characters when supplied; blank is treated as not supplied. |
notes | string | No | Yes | max 500 characters | |
extras | array of ExtraSelectionDto | No | Yes | – | Optional extras to add to the booking, e.g. shoe rental. |
extras[].extraId | string | Yes | – | – | |
extras[].quantity | integer (int32) | Yes | – | min 1 max 100 | |
durationMinutes | integer (int32) | No | Yes | min 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. |
language | string | No | Yes | – | 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. |
children | integer (int32) | No | Yes | min 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. |
highChairs | integer (int32) | No | Yes | min 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}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
reference | path | string | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/reservations/{reference}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
reference | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
resourceType | BookableResourceType | Yes | – | one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The 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. |
resourceId | string | No | Yes | – | 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. |
date | string | Yes | – | – | Venue-local date, "yyyy-MM-dd". |
start | string | Yes | – | – | Venue-local start time, "HH:mm". |
end | string | No | Yes | – | |
partySize | integer (int32) | Yes | – | min 1 max 200 | |
games | integer (int32) | No | Yes | min 1 max 10 | |
customerName | string | Yes | – | length 2–120 | |
email | string | No | Yes | max 256 characters | Optional; at least one of string? UpdateOperatorReservationRequest.Email or string? UpdateOperatorReservationRequest.Phone is required — see IEnumerable<ValidationResult> UpdateOperatorReservationRequest.Validate(ValidationContext validationContext). |
phone | string | No | Yes | length 3–40 | |
notes | string | No | Yes | max 500 characters | |
extras | array of ExtraSelectionDto | No | Yes | – | |
extras[].extraId | string | Yes | – | – | |
extras[].quantity | integer (int32) | Yes | – | min 1 max 100 | |
durationMinutes | integer (int32) | No | Yes | min 15 max 1440 | |
children | integer (int32) | No | Yes | min 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. |
highChairs | integer (int32) | No | Yes | min 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
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
reference | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
resourceId | string | Yes | – | – | The id of the restaurant table to seat the booking at. |
Responses
- 200 OK
POST /api/operator/venue/reservations/{reference}/refund
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
reference | path | string | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/reservations/{reference}/status
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
reference | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
status | ReservationStatus | Yes | – | one of: Pending, Confirmed, Cancelled, Completed, NoShow, PaidButUnavailable | Lifecycle 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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
resourceId | string | No | Yes | – | Code of the resource to block (required on create). |
from | string | No | Yes | – | First blocked date ("yyyy-MM-dd"), or null for no start bound. |
to | string | No | Yes | – | Last blocked date ("yyyy-MM-dd"), or null for no end bound. |
days | array of DayOfWeek | No | Yes | one of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | Weekdays; null or empty means every day. |
startTime | string | No | Yes | – | Start of the daily window ("HH:mm"); give both times or neither. |
endTime | string | No | Yes | – | End of the daily window ("HH:mm"); at or before the start it runs past midnight. |
seats | integer (int32) | No | Yes | – | Seats to block on a seat-sold resource; null blocks the whole resource. |
note | string | No | Yes | – | 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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
resourceId | string | No | Yes | – | Code of the resource to block (required on create). |
from | string | No | Yes | – | First blocked date ("yyyy-MM-dd"), or null for no start bound. |
to | string | No | Yes | – | Last blocked date ("yyyy-MM-dd"), or null for no end bound. |
days | array of DayOfWeek | No | Yes | one of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | Weekdays; null or empty means every day. |
startTime | string | No | Yes | – | Start of the daily window ("HH:mm"); give both times or neither. |
endTime | string | No | Yes | – | End of the daily window ("HH:mm"); at or before the start it runs past midnight. |
seats | integer (int32) | No | Yes | – | Seats to block on a seat-sold resource; null blocks the whole resource. |
note | string | No | Yes | – | 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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | |
description | string | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/resource-groups/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | |
description | string | Yes | – | – | |
ordinal | integer (int32) | Yes | – | – |
Responses
- 200 OK
DELETE /api/operator/venue/resource-groups/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | |
type | BookableResourceType | Yes | – | one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The 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. |
capacity | integer (int32) | Yes | – | – | |
description | string | Yes | – | – | |
slotDurationMinutes | integer (int32) | Yes | Yes | – | 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. |
pricing | ResourcePricingDto | Yes | – | – | Pricing details for a bookable resource. |
pricing.model | PricingModel | Yes | – | one of: Free, PerHour, PerGame, PerSession, FixedFee, Deposit, MinimumSpend | How a bookable resource is priced. |
pricing.amount | number (double) | Yes | – | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.currency | string | Yes | – | – | |
pricing.depositAmount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.minimumSpend | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.unitLabel | string | Yes | – | – | |
pricing.childAmount | number (double) | No | Yes | pattern ^-?(?: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.depositPerPerson | boolean | No | – | default false | Whether DepositAmount is charged per person instead of once per booking (#556). False for every pre-existing resource and payload. |
pricing.childDepositAmount | number (double) | No | Yes | pattern ^-?(?: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. |
allowsFoodOrdering | boolean | Yes | Yes | – | |
seatSold | boolean | No | Yes | – | 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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
code | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | |
type | BookableResourceType | Yes | – | one of: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The 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. |
capacity | integer (int32) | Yes | – | – | |
description | string | Yes | – | – | |
slotDurationMinutes | integer (int32) | Yes | Yes | – | 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. |
pricing | ResourcePricingDto | Yes | – | – | Pricing details for a bookable resource. |
pricing.model | PricingModel | Yes | – | one of: Free, PerHour, PerGame, PerSession, FixedFee, Deposit, MinimumSpend | How a bookable resource is priced. |
pricing.amount | number (double) | Yes | – | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.currency | string | Yes | – | – | |
pricing.depositAmount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.minimumSpend | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.unitLabel | string | Yes | – | – | |
pricing.childAmount | number (double) | No | Yes | pattern ^-?(?: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.depositPerPerson | boolean | No | – | default false | Whether DepositAmount is charged per person instead of once per booking (#556). False for every pre-existing resource and payload. |
pricing.childDepositAmount | number (double) | No | Yes | pattern ^-?(?: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. |
allowsFoodOrdering | boolean | Yes | Yes | – | |
seatSold | boolean | No | Yes | – | 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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
code | path | string | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/resources/{code}/group
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
code | path | string | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
resourceGroupId | string (uuid) | Yes | Yes | – |
Responses
- 200 OK
GET /api/operator/venue/shifts
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
from | query | string (date) | No | – | – |
to | query | string (date) | No | – | – |
memberId | query | string (uuid) | No | – | – |
Responses
- 200 OK
POST /api/operator/venue/shifts
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
memberId | string (uuid) | Yes | – | – | |
date | string (date) | Yes | – | – | |
startTime | string (time) | Yes | – | – | |
endTime | string (time) | Yes | – | – | |
note | string | No | Yes | – |
Responses
- 200 OK
GET /api/operator/venue/shifts/mine
Needs an Auth0 bearer token.
Responses
- 200 OK
PUT /api/operator/venue/shifts/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
memberId | string (uuid) | Yes | – | – | |
date | string (date) | Yes | – | – | |
startTime | string (time) | Yes | – | – | |
endTime | string (time) | Yes | – | – | |
note | string | No | Yes | – |
Responses
- 200 OK
DELETE /api/operator/venue/shifts/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/specials
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
archived | query | boolean | No | – | default false |
Responses
- 200 OK
POST /api/operator/venue/specials
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
kind | SpecialKind | Yes | – | one of: Dish, MenuItem | Dish or a discount on a menu item. |
status | SpecialStatus | Yes | – | one of: Draft, Published, Archived | Draft, live or archived. |
title | string | Yes | – | – | The headline. |
description | string | Yes | Yes | – | Optional description. |
imageUrl | string | Yes | Yes | – | The special's own image. |
price | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price. |
taxRate | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | The tax rate; null means none recorded (a menu-item special inherits the item's). |
menuItemId | string | Yes | Yes | – | The referenced menu item's id, if any. |
sortOrder | integer (int32) | Yes | – | – | Manual order among specials. |
startsOn | string (date) | Yes | Yes | – | First day it runs; null means no lower bound. |
endsOn | string (date) | Yes | Yes | – | Last day it runs; null means no upper bound. |
weekdays | array of DayOfWeek | Yes | Yes | one of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | Days of the week it runs on; null or empty means every day. |
windowStart | string (time) | Yes | Yes | – | Start of the daily window; null means all day. One side alone is refused. |
windowEnd | string (time) | Yes | Yes | – | 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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
date | query | string | No | – | – |
days | query | string | No | – | – |
Responses
- 200 OK
POST /api/operator/venue/specials/preview
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
date | string (date) | Yes | – | – | The day to preview. |
draft | SaveSpecialRequest | No | Yes | – | 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.kind | SpecialKind | Yes | – | one of: Dish, MenuItem | Dish or a discount on a menu item. |
draft.status | SpecialStatus | Yes | – | one of: Draft, Published, Archived | Draft, live or archived. |
draft.title | string | Yes | – | – | The headline. |
draft.description | string | Yes | Yes | – | Optional description. |
draft.imageUrl | string | Yes | Yes | – | The special's own image. |
draft.price | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price. |
draft.taxRate | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | The tax rate; null means none recorded (a menu-item special inherits the item's). |
draft.menuItemId | string | Yes | Yes | – | The referenced menu item's id, if any. |
draft.sortOrder | integer (int32) | Yes | – | – | Manual order among specials. |
draft.startsOn | string (date) | Yes | Yes | – | First day it runs; null means no lower bound. |
draft.endsOn | string (date) | Yes | Yes | – | Last day it runs; null means no upper bound. |
draft.weekdays | array of DayOfWeek | Yes | Yes | one of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | Days of the week it runs on; null or empty means every day. |
draft.windowStart | string (time) | Yes | Yes | – | Start of the daily window; null means all day. One side alone is refused. |
draft.windowEnd | string (time) | Yes | Yes | – | End of the daily window; null means all day. One side alone is refused. |
draftId | string (uuid) | No | Yes | – | The id of a stored special the draft replaces. |
Responses
- 200 OK
GET /api/operator/venue/specials/print
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
date | query | string | No | – | – |
days | query | string | No | – | – |
paper | query | string | No | – | – |
lang | query | string | No | – | – |
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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/specials/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
kind | SpecialKind | Yes | – | one of: Dish, MenuItem | Dish or a discount on a menu item. |
status | SpecialStatus | Yes | – | one of: Draft, Published, Archived | Draft, live or archived. |
title | string | Yes | – | – | The headline. |
description | string | Yes | Yes | – | Optional description. |
imageUrl | string | Yes | Yes | – | The special's own image. |
price | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price. |
taxRate | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | The tax rate; null means none recorded (a menu-item special inherits the item's). |
menuItemId | string | Yes | Yes | – | The referenced menu item's id, if any. |
sortOrder | integer (int32) | Yes | – | – | Manual order among specials. |
startsOn | string (date) | Yes | Yes | – | First day it runs; null means no lower bound. |
endsOn | string (date) | Yes | Yes | – | Last day it runs; null means no upper bound. |
weekdays | array of DayOfWeek | Yes | Yes | one of: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | Days of the week it runs on; null or empty means every day. |
windowStart | string (time) | Yes | Yes | – | Start of the daily window; null means all day. One side alone is refused. |
windowEnd | string (time) | Yes | Yes | – | 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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/staff-access-grants
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
memberId | query | string (uuid) | No | – | – |
Responses
- 200 OK
POST /api/operator/venue/staff-access-grants
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
memberId | string (uuid) | Yes | – | – | |
minutes | integer (int32) | Yes | – | – | |
reason | string | No | Yes | – |
Responses
- 200 OK
DELETE /api/operator/venue/staff-access-grants/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/staff-access-policy
Needs an Auth0 bearer token.
Responses
- 200 OK
PUT /api/operator/venue/staff-access-policy
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
bufferBeforeMinutes | integer (int32) | Yes | – | – | |
bufferAfterMinutes | integer (int32) | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/station-routes
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
routes | array of StationRouteDto | Yes | – | – | |
routes[].stationId | string (uuid) | Yes | – | – | |
routes[].menuId | string | Yes | – | – | |
routes[].groupName | string | No | Yes | – | |
routes[].menuItemId | string | No | Yes | – |
Responses
- 200 OK
GET /api/operator/venue/stations
Needs an Auth0 bearer token.
Responses
- 200 OK
POST /api/operator/venue/stations
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | 1 to 40 characters, unique at the venue (case-insensitive). |
sortOrder | integer (int32) | No | – | default 0 | Where the station is listed; lower first. |
Responses
- 200 OK
PUT /api/operator/venue/stations/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | 1 to 40 characters, unique at the venue (case-insensitive). |
sortOrder | integer (int32) | No | – | default 0 | Where the station is listed; lower first. |
Responses
- 200 OK
DELETE /api/operator/venue/stations/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | |
resourceCodes | array of string | Yes | – | – | |
capacity | integer (int32) | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/table-merges/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | |
resourceCodes | array of string | Yes | – | – | |
capacity | integer (int32) | Yes | – | – |
Responses
- 200 OK
DELETE /api/operator/venue/table-merges/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/team/{memberId}/notification-preferences
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
memberId | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/team/{memberId}/notification-preferences
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
memberId | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
newBookings | boolean | Yes | – | – | |
bookingRequests | boolean | Yes | – | – | |
cancellations | boolean | Yes | – | – | |
guestMessages | boolean | Yes | – | – | |
allOrders | boolean | Yes | – | – | |
orderStationIds | array 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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
onlineSaleEnabled | boolean | Yes | – | – | |
validity | VoucherValidityDto | Yes | Yes | – | 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.mode | VoucherValidityMode | Yes | – | one of: Months, FixedDate, YearEndAfterYears | How a venue's voucher validity rule computes an expiry date from the issue date. |
validity.months | integer (int32) | Yes | Yes | – | |
validity.fixedDate | string | Yes | Yes | – | |
validity.years | integer (int32) | Yes | Yes | – | |
products | array of VoucherProductDto | Yes | – | – | |
products[].id | string | Yes | Yes | – | Null for a new product, which the server mints an id for; a known id is preserved. |
products[].kind | VoucherKind | Yes | – | one of: Amount, Percentage, Item | What a voucher is worth, and so how it redeems. |
products[].titleEn | string | Yes | – | – | |
products[].titleDe | string | Yes | Yes | – | |
products[].vatClassification | VoucherVatClassification | Yes | Yes | one of: SinglePurpose, MultiPurpose | |
products[].amount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | VoucherKind.Amount with a fixed value: the value and the sale price. |
products[].customAmount | boolean | Yes | – | – | VoucherKind.Amount: the buyer picks the value within MinAmount–MaxAmount. |
products[].minAmount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
products[].maxAmount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
products[].percentage | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
products[].maxDiscount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
products[].menuItemId | string | Yes | Yes | – | VoucherKind.Item: the menu item's stable id; it must exist in the venue's menus. |
products[].menuItemName | string | Yes | Yes | – | Ignored on save: the server snapshots the menu item's current name. |
products[].salePrice | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | The online sale price of a percentage or item product; required when it is sold online. |
products[].sellOnline | boolean | Yes | – | – | |
products[].active | boolean | Yes | – | – | |
products[].sortOrder | integer (int32) | Yes | – | – | |
termsEn | string | Yes | Yes | – | |
termsDe | string | Yes | Yes | – |
Responses
- 200 OK
GET /api/operator/venue/vouchers
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
search | query | string | No | – | – |
status | query | string | No | – | – |
page | query | integer (int32) | No | – | – |
pageSize | query | integer (int32) | No | – | – |
Responses
- 200 OK
POST /api/operator/venue/vouchers
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
productId | string | Yes | Yes | – | 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. |
kind | VoucherKind | Yes | Yes | one of: Amount, Percentage, Item | What a voucher is worth, and so how it redeems. |
amount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | Ad hoc VoucherKind.Amount, or the value of a custom-amount product. |
percentage | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
maxDiscount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
menuItemId | string | Yes | Yes | – | Ad hoc VoucherKind.Item: the menu item's stable id. |
vatClassification | VoucherVatClassification | Yes | Yes | one of: SinglePurpose, MultiPurpose | |
payment | VoucherManualPayment | Yes | – | one of: Cash, CardAtTill, NotPaid | How the voucher was paid at the venue; VoucherManualPayment.NotPaid for a promo or goodwill voucher. |
pricePaid | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | What was taken at the till; required unless Payment is VoucherManualPayment.NotPaid. |
expiresOn | string | Yes | Yes | – | Overrides the venue's validity rule (yyyy-MM-dd). A paid voucher must be valid for at least one year. |
recipientName | string | Yes | Yes | – | |
recipientEmail | string | Yes | Yes | – | |
giftMessage | string | Yes | Yes | – | |
language | string | Yes | Yes | – | "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
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
code | string | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/vouchers/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/vouchers/{id}/expiry
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
expiresOn | string | Yes | – | – | |
reason | string | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venue/vouchers/{id}/printable
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/vouchers/{id}/redemptions
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
amount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
billTotal | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
tabSessionId | string (uuid) | Yes | Yes | – | 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. |
tabLineIndex | integer (int32) | Yes | Yes | – | Item vouchers on a tab: the zero-based index into the tab's lines (IReadOnlyList<TabLineDto>? TableTabDto.Lines / IReadOnlyList<TabLineDto> TableSessionResponse.Tab). |
billReference | string | Yes | Yes | – | Optional free text from staff (at most 80 characters), e.g. the till receipt number. |
tabLineItemName | string | No | Yes | – | 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
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
transactionId | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
reason | string | Yes | Yes | – |
Responses
- 200 OK
POST /api/operator/venue/vouchers/{id}/refund
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/vouchers/{id}/resend
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/vouchers/{id}/void
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
reason | string | Yes | – | – |
Responses
- 200 OK
POST /api/operator/venue/zones
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – |
Responses
- 200 OK
PUT /api/operator/venue/zones/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
name | string | Yes | – | – | |
ordinal | integer (int32) | Yes | – | – |
Responses
- 200 OK
DELETE /api/operator/venue/zones/{id}
Needs an Auth0 bearer token.
Parameters
| Name | In | Type | Required | Nullable | Constraints |
|---|---|---|---|---|---|
id | path | string (uuid) | Yes | – | – |
Responses
- 200 OK
GET /api/operator/venues
Needs an Auth0 bearer token.
Responses
- 200 OK
POST /api/operator/venues
Needs an Auth0 bearer token.
Request body application/json
| Field | Type | Required | Nullable | Constraints | Description |
|---|---|---|---|---|---|
slug | string | Yes | – | – | |
name | string | Yes | – | – | |
tagline | string | Yes | – | – | |
description | string | Yes | – | – | |
city | string | Yes | – | – | |
country | string | Yes | – | – | |
timezone | string | Yes | – | – | |
businessProfile | BusinessProfileDto | Yes | – | – | Venue business profile (address + contact), for the operator's edit surface. |
businessProfile.legalName | string | Yes | – | – | |
businessProfile.addressLine1 | string | Yes | – | – | |
businessProfile.addressLine2 | string | Yes | Yes | – | |
businessProfile.city | string | Yes | – | – | |
businessProfile.postalCode | string | Yes | – | – | |
businessProfile.country | string | Yes | – | – | |
businessProfile.phone | string | Yes | – | – | |
businessProfile.email | string | Yes | – | – | |
businessProfile.website | string | Yes | Yes | – | |
paymentPolicy | PaymentPolicyDto | Yes | – | – | Venue payment policy, for the operator's edit surface. |
paymentPolicy.paymentsEnabled | boolean | Yes | – | – | |
paymentPolicy.depositsEnabled | boolean | Yes | – | – | |
paymentPolicy.currency | string | Yes | – | – | |
paymentPolicy.defaultDepositAmount | number (double) | Yes | Yes | pattern ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
preferredLanguage | string | No | – | 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.