Molzait API (1)

Download OpenAPI specification:Download

Floor plan

Interfaces for creating, updating and deleting floor plans

List floor plans

Responses

Response samples

200

Content type

application/json

[{"id": "26261e8115fc-4ef9-9f6b-15ddbdb0b1cd",
"name": "string",
"restaurantId": "ada5ffca16d2-4945-8f24-947f0a64ee81",
"sortIndex": 0,
"tables": {"tableId": {"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
},
"combinations": {"tableId": {"id": "string",
"maxPartySize": 0,
"minPartySize": 0,
"priorityIndex": 0,
"tableIds": ["string"
]
}
},
"elements": {"elementId": {"height": 0,
"rotation": 0,
"width": 0,
"x": 0,
"y": 0,
"type": null,
"backgroundColor": "string"
}
}
}
]

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
required	object A map of visible elements in this floor plan

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"sortIndex": 0,
"tables": {"tableId": {"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
},
"combinations": {"tableId": {"id": "string",
"maxPartySize": 0,
"minPartySize": 0,
"priorityIndex": 0,
"tableIds": ["string"
]
}
},
"elements": {"elementId": {"height": 0,
"rotation": 0,
"width": 0,
"x": 0,
"y": 0,
"type": null,
"backgroundColor": "string"
}
}
}

Response samples

201

Content type

application/json

[{"id": "26261e8115fc-4ef9-9f6b-15ddbdb0b1cd",
"name": "string",
"restaurantId": "ada5ffca16d2-4945-8f24-947f0a64ee81",
"sortIndex": 0,
"tables": {"tableId": {"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
},
"combinations": {"tableId": {"id": "string",
"maxPartySize": 0,
"minPartySize": 0,
"priorityIndex": 0,
"tableIds": ["string"
]
}
},
"elements": {"elementId": {"height": 0,
"rotation": 0,
"width": 0,
"x": 0,
"y": 0,
"type": null,
"backgroundColor": "string"
}
}
}
]

Update a floor plans

path Parameters

floorPlanId

required

string

Request Body schema: application/json
required

name	string
sortIndex	number
	object A map of available tables in this floor plan. The keys of the map are the ids of the table
	object A map of available table combinations in this floor plan. The keys of the map are the ids of the table combination
	object A map of visible elements in this floor plan

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"sortIndex": 0,
"tables": {"tableId": {"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
},
"combinations": {"tableId": {"id": "string",
"maxPartySize": 0,
"minPartySize": 0,
"priorityIndex": 0,
"tableIds": ["string"
]
}
},
"elements": {"elementId": {"height": 0,
"rotation": 0,
"width": 0,
"x": 0,
"y": 0,
"type": null,
"backgroundColor": "string"
}
}
}

Response samples

200

Content type

application/json

[{"id": "26261e8115fc-4ef9-9f6b-15ddbdb0b1cd",
"name": "string",
"restaurantId": "ada5ffca16d2-4945-8f24-947f0a64ee81",
"sortIndex": 0,
"tables": {"tableId": {"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
},
"combinations": {"tableId": {"id": "string",
"maxPartySize": 0,
"minPartySize": 0,
"priorityIndex": 0,
"tableIds": ["string"
]
}
},
"elements": {"elementId": {"height": 0,
"rotation": 0,
"width": 0,
"x": 0,
"y": 0,
"type": null,
"backgroundColor": "string"
}
}
}
]

Delete a floor plans

path Parameters

floorPlanId

required

string

Responses

Availability

Interfaces for requesting currently available slots

Listing experiences

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": {"de": "string",
"en": "string"
},
"shortDescription": {"de": "string",
"en": "string"
},
"descriptionHtml": {"de": "string",
"en": "string"
},
"image": {"path": "string",
"url": "string"
},
"minPartySize": 0,
"maxPartySize": 0,
"availableDays": [{"day": "string",
"allowCategorySelection": true,
"floorPlanIds": ["string"
],
"isAvailable": true,
"message": {"customMessage": {"de": "string",
"en": "string"
},
"messageType": null
}
}
],
"isSingleDayEvent": true,
"paymentSettings": { }
}
]

Listing available slots

query Parameters

reservationId required	any Example: reservationId=25dbbd8fd1cd-4773-96da-ad40fe2efc35 When updating a reservation send the id of the reservation to exclude it from the availability calculation
experienceId required	any Example: experienceId=dad91a3e5b5a-4954-88fe-962f95485577
day required	any Example: day=2024-01-02
attendees required	any Example: attendees=2

Responses

Response samples

200

Content type

application/json

{"slots": [{"restaurantId": "ada5ffca16d2-4945-8f24-947f0a64ee81",
"experienceId": "dad91a3e5b5a-4954-88fe-962f95485577",
"day": "2024-01-02",
"minutes": 600,
"duration": 120,
"attendees": 4,
"spotsTotal": 10,
"spotsOpen": 5,
"seated": 45,
"seatedLimit": 50,
"starting": 15,
"startingLimit": 20,
"availableAssignments": [{"floorPlanId": "string",
"maxPartySize": 0,
"minPartySize": 0,
"reservable": true,
"score": 0.122,
"tableCategoryIds": ["string"
],
"tableIds": ["string"
]
}
],
"exclusionReasons": ["no_tables_found"
],
"availableFloorPlanIds": ["string"
],
"assignmentsAvailableIn": ["string"
],
"confirmationMode": "instant",
"showEndTime": true,
"paymentSettings": {"pendingMinutes": 0,
"pricing": {"amountPerPax": 0,
"fullAmountPerPax": 0,
"type": null
},
"refundMinutes": 0,
"requiredFromPax": 0,
"type": "deposit"
}
}
]
}

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	Array of any Example: status=seated&status=booked

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"attendees": 0,
"experience": {"id": "string",
"name": {"en": "A lá carte",
"de": "A lá carte"
},
"shorthand": "string"
},
"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": {"id": "5636d6336d5d-4b78-96e4-4089e4d880b0",
"firstName": "John",
"lastName": "Doe",
"company": "BestCorp Inc.",
"locale": "de",
"phone": "+436605512234",
"email": "john.doe@example.com",
"notes": "Likes to drink red wine"
},
"pinnedTables": [{"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
],
"labels": [{"id": "1838eb4bad1e-442e-b415-564f3b24904a",
"name": "VIP",
"icon": "star",
"type": "guestbook"
}
],
"specialRequestNotes": "string",
"internalNotes": "string",
"payment": {"type": null,
"amount": 0,
"paymentIntentId": "string",
"refundMinutes": 0,
"state": "paid"
}
}
]

Create a reservation

Request Body schema: application/json
required

attendees required	number
day required	string
email	string
experienceId required	string
firstName	string
lastName required	string
locale required	string Enum: "en" "de"
minutes required	number
newsletterSignup	boolean
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.

Responses

Request samples

Payload

Content type

application/json

{"attendees": 2,
"day": "2024-01-02",
"email": "john.doe@example.com",
"experienceId": "dad91a3e5b5a-4954-88fe-962f95485577",
"firstName": "John",
"lastName": "Doe",
"locale": "en",
"minutes": 600,
"newsletterSignup": true,
"notes": "Comes with a dog",
"phone": "+436605512234",
"pinnedTableIds": ["9eaedce58b28-48bb-93ba-abb5ea866d8e"
]
}

Response samples

201

Content type

application/json

{"id": "string",
"attendees": 0,
"experience": {"id": "string",
"name": {"en": "A lá carte",
"de": "A lá carte"
},
"shorthand": "string"
},
"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": {"id": "5636d6336d5d-4b78-96e4-4089e4d880b0",
"firstName": "John",
"lastName": "Doe",
"company": "BestCorp Inc.",
"locale": "de",
"phone": "+436605512234",
"email": "john.doe@example.com",
"notes": "Likes to drink red wine"
},
"pinnedTables": [{"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
],
"labels": [{"id": "1838eb4bad1e-442e-b415-564f3b24904a",
"name": "VIP",
"icon": "star",
"type": "guestbook"
}
],
"specialRequestNotes": "string",
"internalNotes": "string",
"payment": {"type": null,
"amount": 0,
"paymentIntentId": "string",
"refundMinutes": 0,
"state": "paid"
}
}

Load a reservation

path Parameters

reservationId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"attendees": 0,
"experience": {"id": "string",
"name": {"en": "A lá carte",
"de": "A lá carte"
},
"shorthand": "string"
},
"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": {"id": "5636d6336d5d-4b78-96e4-4089e4d880b0",
"firstName": "John",
"lastName": "Doe",
"company": "BestCorp Inc.",
"locale": "de",
"phone": "+436605512234",
"email": "john.doe@example.com",
"notes": "Likes to drink red wine"
},
"pinnedTables": [{"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
],
"labels": [{"id": "1838eb4bad1e-442e-b415-564f3b24904a",
"name": "VIP",
"icon": "star",
"type": "guestbook"
}
],
"specialRequestNotes": "string",
"internalNotes": "string",
"payment": {"type": null,
"amount": 0,
"paymentIntentId": "string",
"refundMinutes": 0,
"state": "paid"
}
}

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" "seated" "ordered" "paid" "declined" "finished" "cancelled" "no_show" "voided"
day	string
minutes	number
attendees	number

Responses

Request samples

Payload

Content type

application/json

{"status": "requested",
"day": "string",
"minutes": 0,
"attendees": 0
}

Response samples

200

Content type

application/json

{"id": "string",
"attendees": 0,
"experience": {"id": "string",
"name": {"en": "A lá carte",
"de": "A lá carte"
},
"shorthand": "string"
},
"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": {"id": "5636d6336d5d-4b78-96e4-4089e4d880b0",
"firstName": "John",
"lastName": "Doe",
"company": "BestCorp Inc.",
"locale": "de",
"phone": "+436605512234",
"email": "john.doe@example.com",
"notes": "Likes to drink red wine"
},
"pinnedTables": [{"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
],
"labels": [{"id": "1838eb4bad1e-442e-b415-564f3b24904a",
"name": "VIP",
"icon": "star",
"type": "guestbook"
}
],
"specialRequestNotes": "string",
"internalNotes": "string",
"payment": {"type": null,
"amount": 0,
"paymentIntentId": "string",
"refundMinutes": 0,
"state": "paid"
}
}

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

required

string

Responses

Request samples

Payload

Content type

application/json

{"tableName": "string"
}

Response samples

200
201

Content type

application/json

{"id": "string",
"attendees": 0,
"experience": {"id": "string",
"name": {"en": "A lá carte",
"de": "A lá carte"
},
"shorthand": "string"
},
"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": {"id": "5636d6336d5d-4b78-96e4-4089e4d880b0",
"firstName": "John",
"lastName": "Doe",
"company": "BestCorp Inc.",
"locale": "de",
"phone": "+436605512234",
"email": "john.doe@example.com",
"notes": "Likes to drink red wine"
},
"pinnedTables": [{"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
],
"labels": [{"id": "1838eb4bad1e-442e-b415-564f3b24904a",
"name": "VIP",
"icon": "star",
"type": "guestbook"
}
],
"specialRequestNotes": "string",
"internalNotes": "string",
"payment": {"type": null,
"amount": 0,
"paymentIntentId": "string",
"refundMinutes": 0,
"state": "paid"
}
}

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

required

string

Responses

Request samples

Payload

Content type

application/json

{"tableName": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"attendees": 0,
"experience": {"id": "string",
"name": {"en": "A lá carte",
"de": "A lá carte"
},
"shorthand": "string"
},
"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": {"id": "5636d6336d5d-4b78-96e4-4089e4d880b0",
"firstName": "John",
"lastName": "Doe",
"company": "BestCorp Inc.",
"locale": "de",
"phone": "+436605512234",
"email": "john.doe@example.com",
"notes": "Likes to drink red wine"
},
"pinnedTables": [{"id": "9eaedce58b28-48bb-93ba-abb5ea866d8e",
"minPartySize": 2,
"maxPartySize": 4,
"name": "45",
"priorityIndex": 0,
"reservable": true,
"rotation": 90,
"tableCategoryIds": ["ec5dcbafbf56-4274-b468-ec635b8df95b"
],
"type": "rect_one",
"x": 100,
"y": 250
}
],
"labels": [{"id": "1838eb4bad1e-442e-b415-564f3b24904a",
"name": "VIP",
"icon": "star",
"type": "guestbook"
}
],
"specialRequestNotes": "string",
"internalNotes": "string",
"payment": {"type": null,
"amount": 0,
"paymentIntentId": "string",
"refundMinutes": 0,
"state": "paid"
}
}

Widget

Widget bootstrap data

path Parameters

restaurantId

required

string

query Parameters

experienceId

string

Responses

Response samples

200

Content type

application/json

{"restaurantId": "string",
"experiences": [{"id": "string",
"name": {"de": "string",
"en": "string"
},
"shortDescription": {"de": "string",
"en": "string"
},
"descriptionHtml": {"de": "string",
"en": "string"
},
"image": {"path": "string",
"url": "string"
},
"minPartySize": 0,
"maxPartySize": 0,
"availableDays": [{"day": "string",
"allowCategorySelection": true,
"floorPlanIds": ["string"
],
"isAvailable": true,
"message": {"customMessage": {"de": "string",
"en": "string"
},
"messageType": null
}
}
],
"isSingleDayEvent": true,
"paymentSettings": { }
}
],
"minPartySize": 0,
"maxPartySize": 0,
"formalLanguage": true,
"newsletterSignupEnabled": true,
"address": [{ }
],
"tableCategories": [{"id": "string",
"name": {"de": "string",
"en": "string"
},
"description": {"de": "string",
"en": "string"
}
}
],
"branding": { },
"email": "string",
"restaurantName": "string",
"countryCode": "string",
"phone": "string",
"restaurantTimezone": "string",
"description": {"de": "string",
"en": "string"
},
"websiteUrl": "string"
}

Listing availability

path Parameters

restaurantId

required

string

query Parameters

experienceId required	any
day required	any
attendees required	any

Responses

Response samples

200

Content type

application/json

{"slots": [{"minutes": 0,
"day": "string",
"duration": 0,
"available": true,
"availableCategoryIds": ["string"
],
"autoConfirm": true,
"requiresPayment": true
}
]
}

Creating a reservation

path Parameters

restaurantId

required

string

Request Body schema: application/json
required

experienceId required	string
attendees required	number
day required	string
minutes required	number
firstName required	string
lastName required	string
phone required	string
email required	string
notes required	object
locale required	string Enum: "en" "de"
newsletterSignup required	boolean
tableCategoryId	string
originUrl required	string

Responses

Request samples

Payload

Content type

application/json

{"experienceId": "string",
"attendees": 0,
"day": "string",
"minutes": 0,
"firstName": "string",
"lastName": "string",
"phone": "string",
"email": "string",
"notes": { },
"locale": "en",
"newsletterSignup": true,
"tableCategoryId": "string",
"originUrl": "string"
}

Response samples

201

Content type

application/json

{"type": "success",
"redirectUrl": "string",
"reservation": {"id": "string",
"number": "string",
"attendees": 0,
"experienceId": "string",
"startTime": "string",
"endTime": "string",
"status": "requested",
"needsSpecialRequestConfirmation": true
}
}

Cancel a reservation

path Parameters

restaurantId required	string
reservationId required	string

Molzait API (1)

Floor plan

List floor plans

Responses

Response samples

Create a new floor plans

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update a floor plans

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a floor plans

path Parameters

Responses

Availability

Listing experiences

Responses

Response samples

Listing available slots

query Parameters

Responses

Response samples

Reservations

List reservations

query Parameters

Responses

Response samples

Create a reservation

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Load a reservation

path Parameters

Responses

Response samples

Update reservation

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Check-In

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Check-Out

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Widget

Widget bootstrap data

path Parameters

query Parameters

Responses

Response samples

Listing availability

path Parameters

query Parameters

Responses

Response samples

Creating a reservation

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Cancel a reservation

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required