Update Booking Status
PATCH
/venues/{venueId}/bookings/{bookingId}
Changes the state of a Booking. Only a few of the states are available to be set through the API. The others are set through other processes.
State Flow
States can only increase in level.
| State | LEVEL | SET BY | ACCESS | Description |
|---|---|---|---|---|
| REGISTERED | 0 | Default state for a newly created Booking. |
||
| UNCONFIRMED | 1 | External |
State set externally for when integrator has sent confirmation message to the guest, but have not got the response yet. | |
| CONFIRMED | 2 | External |
State set externally 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 |
BLOCKED |
Set internally, the Booking is blocked from changes through the API. |
| SEATED | 4 | Internal |
BLOCKED |
Set internally, the Booking is blocked from changes through the API. |
| BILL_PRINTED | 5 | Internal |
BLOCKED |
Set internally, the Booking is blocked from changes through the API. |
| CLOSED | 6 | Internal |
READ-ONLY |
Set internally, the Booking has been finalized and can no longer be changed. |
| NO_SHOW | 6 | Internal |
READ-ONLY |
Set internally, the Booking has been finalized and can no longer be changed. |
| CANCELLED | 6 | Internal, External |
READ-ONLY |
Set internally or by the API. The Booking has been finalized and can no longer be changed. |
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)
Request Body
application/json
JSON
{
"state": "string"
}
Responses
OK
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"
]
}
}