Booking specification
Stay organized with collections
Save and categorize content based on your preferences.
A Booking is an appointment for an inventory slot. It contains the information
needed to identify and make the appointment.
// A booking for an inventory slot
message Booking {
// ID of this booking (required)
string booking_id = 1;
// The appointment slot of this booking (required for CreateBooking and
// UpdateBooking:modify, but not UpdateBooking:cancel)
Slot slot = 2;
// Personal information of the user making the appointment (required for
// CreateBooking)
UserInformation user_information = 3;
// Status of the booking (required for CreateBooking and UpdateBooking:cancel,
// but not UpdateBooking:modify)
BookingStatus status = 4;
// Information about payment transactions that relate to the booking.
// (optional)
PaymentInformation payment_information = 5;
// Information about virtual session related to this booking. (optional)
VirtualSessionInfo virtual_session_info = 6;
}
Create a booking
There are two ways to create a Booking:
- A Booking can be created directly from a
Slot.
- With optional support of
Lease, a Lease is
created for the Slot first and then finalized into a Booking.
See CreateBooking
for details.
Update a booking
A Booking can be updated, i.e., rescheduled or cancelled.
See UpdateBooking
for details.
Get status for a booking
Booking status (see
BookingStatus)
and Prepayment status (see
PrepaymentStatus)
of a Booking can be read via
GetBookingStatus
and ListBookings.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-20 UTC.
[null,null,["Last updated 2025-05-20 UTC."],[[["\u003cp\u003eA Booking represents an appointment for an inventory slot and contains details like user information, booking status, and payment information.\u003c/p\u003e\n"],["\u003cp\u003eBookings can be created directly from a Slot or by finalizing a Lease.\u003c/p\u003e\n"],["\u003cp\u003eExisting Bookings can be updated to reschedule or cancel them.\u003c/p\u003e\n"],["\u003cp\u003eBooking status and Prepayment status can be retrieved using GetBookingStatus and ListBookings methods.\u003c/p\u003e\n"]]],["A `Booking` represents an appointment for an inventory slot and includes a `booking_id`, `slot`, `user_information`, `status`, and optional `payment_information` and `virtual_session_info`. Bookings are created from a `Slot`, or optionally via a `Lease`. Bookings can be updated, meaning they can be rescheduled or canceled. The booking's status, and optionally its prepayment status, can be retrieved via `GetBookingStatus` or `ListBookings`. The method `CreateBooking` is used to create a Booking, and `UpdateBooking` to update it.\n"],null,["# Booking specification\n\nA Booking is an appointment for an inventory slot. It contains the information\nneeded to identify and make the appointment. \n\n```scilab\n// A booking for an inventory slot\nmessage Booking {\n // ID of this booking (required)\n string booking_id = 1;\n\n // The appointment slot of this booking (required for CreateBooking and\n // UpdateBooking:modify, but not UpdateBooking:cancel)\n Slot slot = 2;\n\n // Personal information of the user making the appointment (required for\n // CreateBooking)\n UserInformation user_information = 3;\n\n // Status of the booking (required for CreateBooking and UpdateBooking:cancel,\n // but not UpdateBooking:modify)\n BookingStatus status = 4;\n\n // Information about payment transactions that relate to the booking.\n // (optional)\n PaymentInformation payment_information = 5;\n\n // Information about virtual session related to this booking. (optional)\n VirtualSessionInfo virtual_session_info = 6;\n}\n```\n\nCreate a booking\n----------------\n\nThere are two ways to create a Booking:\n\n- A Booking can be created directly from a [Slot](/actions-center/reference/grpc-api-v2/slot-specification).\n- With optional support of [Lease](/actions-center/reference/grpc-api-v2/lease-specification), a Lease is created for the Slot first and then finalized into a Booking.\n\nSee [CreateBooking](/actions-center/reference/grpc-api-v2/createbooking-method)\nfor details.\n\nUpdate a booking\n----------------\n\nA Booking can be updated, i.e., rescheduled or cancelled. \n\nSee [UpdateBooking](/actions-center/reference/grpc-api-v2/updatebooking-method)\nfor details.\n\nGet status for a booking\n------------------------\n\nBooking status (see\n[BookingStatus](/actions-center/reference/grpc-api-v2/booking-status-specification))\nand Prepayment status (see\n[PrepaymentStatus](/actions-center/reference/grpc-api-v2/payment-specification))\nof a Booking can be read via\n[GetBookingStatus](/actions-center/reference/grpc-api-v2/getbookingstatus-method)\nand [ListBookings](/actions-center/reference/grpc-api-v2/listbookings-method)."]]