API docs by Redocly

Molzait API (1)

Download OpenAPI specification:Download

Restaurant

Interfaces for getting details about the restaurant

Get restaurant details

Responses

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "restaurantName": "The Grand Bistro",
  • "internalRestaurantName": "TGB_MAIN_01",
  • "address": {
    },
  • "phone": "+431234567890",
  • "email": "contact@grandbistro.com",
  • "socialUrls": {},
  • "branding": {
    },
  • "websiteUrl": "https://grandbistro.com",
  • "termsOfServiceUrl": { },
  • "privacyPolicyUrl": { },
  • "timezone": "Europe/Vienna",
  • "description": {
    }
}

List restaurant labels

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Floor plan

Interfaces for creating, updating and deleting floor plans

List floor plans

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new floor plans

Request Body schema: application/json
required
name
required
string
sortIndex
required
number
required
object

A map of available tables in this floor plan. The keys of the map are the ids of the table

required
object

A map of available table combinations in this floor plan. The keys of the map are the ids of the table combination

elements
required
object

A map of visible elements in this floor plan

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "sortIndex": 0,
  • "tables": {
    },
  • "combinations": {
    },
  • "elements": { }
}

Response samples

Content type
application/json
{
  • "id": "0daf8326bd9b-4bd3-874f-20b99444d677",
  • "name": "string",
  • "restaurantId": "b0ea2fecf6e9-497e-b32b-b3dd25f4f806",
  • "sortIndex": 0,
  • "tables": {
    },
  • "combinations": {
    },
  • "elements": { }
}

Update a floor plans

path Parameters
floorPlanId
required
string
Request Body schema: application/json
required
name
required
string
sortIndex
required
number
required
object

A map of available tables in this floor plan. The keys of the map are the ids of the table

required
object

A map of available table combinations in this floor plan. The keys of the map are the ids of the table combination

elements
required
object

A map of visible elements in this floor plan

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "sortIndex": 0,
  • "tables": {
    },
  • "combinations": {
    },
  • "elements": { }
}

Response samples

Content type
application/json
{
  • "id": "0daf8326bd9b-4bd3-874f-20b99444d677",
  • "name": "string",
  • "restaurantId": "b0ea2fecf6e9-497e-b32b-b3dd25f4f806",
  • "sortIndex": 0,
  • "tables": {
    },
  • "combinations": {
    },
  • "elements": { }
}

Delete a floor plans

path Parameters
floorPlanId
required
string

Responses

Availability

Interfaces for requesting currently available slots

Listing experiences

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listing available slots

query Parameters
attendees
required
number
Example: attendees=2

Number of attendees

day
required
string
Example: day=2024-06-10

The day to query time slots

experienceId
required
string
Example: experienceId=a0d7aa2ecba4-4592-a044-f79fa34e70c4
reservationId
string
Example: reservationId=b6d8849b7e17-48fe-b295-f6fe1082b914

When updating a reservation send the id of the reservation to exclude it from the availability calculation

Responses

Response samples

Content type
application/json
{
  • "slots": [
    ]
}

Reservations

Interfaces for interacting with restaurant reservations

List reservations

query Parameters
from
required
string
Example: from=2023-01-01
to
required
string
Example: to=2023-01-31
status
string
Enum: "requested" "unconfirmed" "payment_pending" "booked" "reconfirmed" "arrived" "seated" "ordered" "paid" "declined" "finished" "cancelled" "no_show" "voided"
Example: status=seated&status=booked
includeWalkIns
boolean
Example: includeWalkIns=true

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a reservation

Request Body schema: application/json
required
attendees
required
number

The number of attendees for this reservation

day
required
string <yyyy-mm-dd>

The day of the reservation

email
string
experienceId
required
string
firstName
string
lastName
required
string
locale
required
string
Enum: "en" "de"
minutes
required
number

Minutes since the start of the day based in the restaurants configured timezone. 600 = 10:00

notes
string or null
phone
string
pinnedTableIds
Array of strings

Set the table ids of this reservation. When omitted, the tables will be selected automatically.

labelIds
Array of strings

Set the label ids to add to this reservation

Responses

Request samples

Content type
application/json
{
  • "attendees": 2,
  • "day": "2024-01-02",
  • "email": "john.doe@example.com",
  • "experienceId": "a0d7aa2ecba4-4592-a044-f79fa34e70c4",
  • "firstName": "John",
  • "lastName": "Doe",
  • "locale": "en",
  • "minutes": 600,
  • "notes": "Comes with a dog",
  • "phone": "+436605512234",
  • "pinnedTableIds": [
    ],
  • "labelIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "number": "string",
  • "attendees": 0,
  • "experience": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "checkinTime": "2019-08-24T14:15:22Z",
  • "checkoutTime": "2019-08-24T14:15:22Z",
  • "status": "requested",
  • "source": "app",
  • "restaurantId": "string",
  • "guest": {
    },
  • "pinnedTables": [
    ],
  • "labels": [
    ],
  • "specialRequestNotes": "string",
  • "internalNotes": "string",
  • "payment": {
    }
}

Load a reservation

path Parameters
reservationId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "number": "string",
  • "attendees": 0,
  • "experience": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "checkinTime": "2019-08-24T14:15:22Z",
  • "checkoutTime": "2019-08-24T14:15:22Z",
  • "status": "requested",
  • "source": "app",
  • "restaurantId": "string",
  • "guest": {
    },
  • "pinnedTables": [
    ],
  • "labels": [
    ],
  • "specialRequestNotes": "string",
  • "internalNotes": "string",
  • "payment": {
    }
}

Update reservation

Currently only status updates are allowed

path Parameters
reservationId
required
string
Request Body schema: application/json
required
status
string
Enum: "requested" "unconfirmed" "payment_pending" "booked" "reconfirmed" "arrived" "seated" "ordered" "paid" "declined" "finished" "cancelled" "no_show" "voided"
day
string
minutes
number
attendees
number
tableIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "status": "requested",
  • "day": "string",
  • "minutes": 0,
  • "attendees": 0,
  • "tableIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "number": "string",
  • "attendees": 0,
  • "experience": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "checkinTime": "2019-08-24T14:15:22Z",
  • "checkoutTime": "2019-08-24T14:15:22Z",
  • "status": "requested",
  • "source": "app",
  • "restaurantId": "string",
  • "guest": {
    },
  • "pinnedTables": [
    ],
  • "labels": [
    ],
  • "specialRequestNotes": "string",
  • "internalNotes": "string",
  • "payment": {
    }
}

Check-In

Searches a booked reservation currently starting (+/- 15 minutes) for the given table. If one is found the reservation will be checked in. If no reservation is found a new Walk-In will be created

Request Body schema: application/json
required
tableName
string
tableIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tableName": "102",
  • "tableIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "number": "string",
  • "attendees": 0,
  • "experience": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "checkinTime": "2019-08-24T14:15:22Z",
  • "checkoutTime": "2019-08-24T14:15:22Z",
  • "status": "requested",
  • "source": "app",
  • "restaurantId": "string",
  • "guest": {
    },
  • "pinnedTables": [
    ],
  • "labels": [
    ],
  • "specialRequestNotes": "string",
  • "internalNotes": "string",
  • "payment": {
    }
}

Check-Out

Searches an active reservation on the current day for the given table. If one is found, the reservation will be set to paid and automatically finished after a few minutes.

Request Body schema: application/json
required
tableName
string
tableIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tableName": "102",
  • "tableIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "number": "string",
  • "attendees": 0,
  • "experience": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "checkinTime": "2019-08-24T14:15:22Z",
  • "checkoutTime": "2019-08-24T14:15:22Z",
  • "status": "requested",
  • "source": "app",
  • "restaurantId": "string",
  • "guest": {
    },
  • "pinnedTables": [
    ],
  • "labels": [
    ],
  • "specialRequestNotes": "string",
  • "internalNotes": "string",
  • "payment": {
    }
}

Gift cards

Interfaces to create, top up and redeem gift cards

Request a gift card

path Parameters
giftCardId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "remainingAmount": 0,
  • "templateId": "string",
  • "image": {
    },
  • "email": "string",
  • "expiresOnDay": "2050-12-31",
  • "locale": "en",
  • "creationTimestamp": "2019-08-24T14:15:22Z"
}

Create a gift card

Request Body schema: application/json
required
amount
required
number

The initial amount when creating this gift card

templateId
required
string

The template of the gift card

email
string

The customers email address

expiresOnDay
required
string

The day the gift card expires

locale
string
Enum: "en" "de"

The customers locale. Emails will be sent using this locale

id
string

The code of this gift card. Can be left empty to generate one

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "templateId": "string",
  • "email": "string",
  • "expiresOnDay": "2050-12-31",
  • "locale": "en",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "remainingAmount": 0,
  • "templateId": "string",
  • "image": {
    },
  • "email": "string",
  • "expiresOnDay": "2050-12-31",
  • "locale": "en",
  • "creationTimestamp": "2019-08-24T14:15:22Z"
}

Create a gift card transaction

Request Body schema: application/json
required
status
required
string
Enum: "pending" "successful"

The status of the transaction

amount
required
number

Amount of the transaction in cents. Positive values top up. Negative values redeem the gift card.

reference
string

Responses

Request samples

Content type
application/json
{
  • "status": "successful",
  • "amount": 10000,
  • "reference": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "successful",
  • "amount": 10000,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "reference": "string"
}

Update a gift card transaction

path Parameters
giftCardId
required
string
transactionId
required
string
Request Body schema: application/json
required
status
required
string
Enum: "pending" "successful"

The status of the transaction

reference
string

Responses

Request samples

Content type
application/json
{
  • "status": "successful",
  • "reference": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "successful",
  • "amount": 10000,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "reference": "string"
}

Creates a new transaction to refund the transaction with the given id

path Parameters
giftCardId
required
string
transactionId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "successful",
  • "amount": 10000,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "reference": "string"
}

Phone calls

Interfaces for reporting incoming calls

Incoming call

Report an status update regarding an incoming call

path Parameters
phoneNumberId
required
string
Request Body schema: application/json
required
id
required
string

An unique UUID that identifies the call in the external phone system. Min length is 10 characters

phoneNumber
string

An E.164 formatted phone number, or empty if hidden

status
required
string
Enum: "ringing" "picked_up" "hung_up" "abandoned"

The current status of the call

Responses

Request samples

Content type
application/json
{
  • "id": "90e4020a-a9d1-4a06-8906-fec2126cc007",
  • "phoneNumber": "+436601123345",
  • "status": "ringing"
}

Guest

List guests

query Parameters
limit
number
Example: limit=100

Maximum number of results to return (max: 100)

page
number
Example: page=1

Page number for pagination

search
string
Example: search=john

Search query to match against guest names, email, phone, company, or notes

email
string
Example: email=john.doe@example.com

Filter by email address

phone
string
Example: phone=+436605512234

Filter by phone number

company
string
Example: company=BestCorp Inc.

Filter by company name

locale
string
Enum: "en" "de"
Example: locale=de

Filter by guest locale

labelIds
Array of strings
Example: labelIds=label-id-1&labelIds=label-id-2

Filter by label IDs (can be array or comma-separated string)

sortBy
string
Enum: "lastName:asc" "lastName:desc" "firstName:asc" "firstName:desc" "totalVisits:asc" "totalVisits:desc" "totalCovers:asc" "totalCovers:desc" "lastVisit.seconds:asc" "lastVisit.seconds:desc"
Example: sortBy=lastName:asc

Sort results. Available fields: lastName, firstName, totalVisits, totalCovers, lastVisit.seconds, firstVisit.seconds

hasEmail
boolean
Example: hasEmail=true

Include only guests with email addresses

hasPhone
boolean
Example: hasPhone=true

Include only guests with phone numbers

Responses

Response samples

Content type
application/json
[
  • {
    }
]