Update Booking
PUT
/venues/{venueId}/bookings/{bookingId}
Ability to update details about the booking. Partial update is not supported so a booking should be fetched using bookingId path parameter first before performing the update. Please note that the booking state can only be manipulated through a separate method.
Important
statuschanges are not supported usingPUTbut are instead modified usingPATCH. See theUpdate Booking Stateendpoint.
| *State | LEVEL | ACCESS | Description |
|---|---|---|---|
| REGISTERED | 0 | Default state for a newly created Booking. |
|
| UNCONFIRMED | 1 | External |
External state for when integrator has sent confirmation message to the guest, but have not got the response yet. |
| CONFIRMED | 2 | External |
External state for when the integrator has got a positive confirmation response from the guest. If the response is negative then the Booking should get the CANCELLED state. |
| WAITING | 3 | Internal, Read-Only |
Internal state, cannot be set through API. The Booking is active and cannot be updated by the API. |
| SEATED | 4 | Internal, Read-Only |
Internal state, cannot be set through API. The Booking is active and cannot be updated by the API. |
| BILL_PRINTED | 5 | Internal, Read-Only |
Internal state, cannot be set through API. The Booking is active and cannot be updated by the API. |
| CLOSED | 6 | Internal |
Internal state, cannot be set through API. |
| NO_SHOW | 6 | Internal |
Internal state, cannot be set through API. |
| CANCELLED | 6 | Internal, External |
The Booking has been cancelled. |
Authorizations
OAuth2
clientCredentials Flow
Token URL
"https://login.microsoftonline.com/{issuer}/oauth2/v2.0/token"Scopes:
or
X-API-KEY
Is made available as part of the onboading/integration process.
Type
API Key (header: X-API-KEY)
Parameters
Header Parameters
X-API-KEY*
Client-specific key.
Type
Requiredstring
Request Body
application/json
JSON
{
"id": "20230221081212-2db89a3f-766a-421e-922a-dbb77fe011d3",
"status": "string",
"timeSlotId": "trlY5s1zestnjauIG8YcqMAyIEys7AQimt+n9CKG+67RbWHLHy952+PU5LUDHQWD",
"venueId": 149,
"timeFrom": "2023-01-11T17:00:00Z",
"timeTo": "2023-01-11T19:00:00Z",
"guest": {
"firstName": "John",
"lastName": "Doe",
"phone": "4790090090",
"email": "john@doe.com"
},
"guestCount": 2,
"comment": "We might arrive 10 minutes late.",
"extReferenceId": "6ecfc7e7-7b31-4b4c-97a3-a3888d2ade94",
"extReferenceNumber": "123",
"extProperties": {
"additionalProperties": "string"
},
"scenarioName": "Breakfast",
"noShowFee": {
"amountPreAuthorized": 500,
"amountToCapture": 250
},
"tags": [
"string"
],
"types": [
"string"
]
}
Responses
Success
application/json
JSON
{
"data": {
"id": "20230221081212-2db89a3f-766a-421e-922a-dbb77fe011d3",
"status": "string",
"timeSlotId": "trlY5s1zestnjauIG8YcqMAyIEys7AQimt+n9CKG+67RbWHLHy952+PU5LUDHQWD",
"venueId": 149,
"timeFrom": "2023-01-11T17:00:00Z",
"timeTo": "2023-01-11T19:00:00Z",
"guest": {
"firstName": "John",
"lastName": "Doe",
"phone": "4790090090",
"email": "john@doe.com"
},
"guestCount": 2,
"comment": "We might arrive 10 minutes late.",
"extReferenceId": "6ecfc7e7-7b31-4b4c-97a3-a3888d2ade94",
"extReferenceNumber": "123",
"extProperties": {
"additionalProperties": "string"
},
"scenarioName": "Breakfast",
"noShowFee": {
"amountPreAuthorized": 500,
"amountToCapture": 250
},
"tags": [
"string"
],
"types": [
"string"
]
}
}