Update Booking

This endpoint is for updating a booking

Request
Security:
path Parameters
bookingId
required
string

Id of the booking in Tyro Connect that should be updated

header Parameters
Authorization
required
string
Default: Bearer {$$.env.access_token}
Accept
required
string (acceptHeaderBooking1_0)
Default: application/vnd.tyro.connect+json;version=0.1

Specifies which version of the API to use. If no value is provided then 0.1 version will be used

Enum: "application/vnd.tyro.connect+json;version=1.0" "application/vnd.tyro.connect+json;version=0.1"
Content-Type
required
string
Value: "application/merge-patch+json"
Request Body schema: application/merge-patch+json
bookingStatus
string (bookingStatus)

The status of the booking within the Booking system

Enum: "CREATED" "ACCEPTED" "CANCELLED_BY_CUSTOMER" "CANCELLED_BY_MERCHANT" "REJECTED"
object
numberOfPeople
number (numberOfPeople) >= 1

The number of guests

reason
string (reason) <= 50 characters

The reason the booking was rejected or cancelled. Provided only when bookingStatus is REJECTED, CANCELLED_BY_MERCHANT or CANCELLED_BY_CUSTOMER

Responses
204

No body content

400

When the provided status is not valid

403

When you don't have the right permissions to update the booking

404

When the provided bookingId does not match a booking stored in the system

patch/bookings/{bookingId}
Request samples
application/merge-patch+json
{
  • "asset": {
    }
}
Response samples
application/json
{
  • "error": "\"asset.tableStatus\" must be one of [SEATED, DINING, FINALISED, CLOSING]"
}
Copyright © Tyro Payments 2019-2024. All right reserved.