Booking definition
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.
Booking Definition
// A booking for an inventory slot
message Booking {
// ID of this booking, which must be unique across all bookings. (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;
// Information about the Offer applied to this booking.
//
// Required in CreateBookingResponse if an offer_id was set on the
// CreateBookingRequest that created the Booking.
OfferInfo offer_info = 7;
}
OfferInfo Definition
// Information about an Offer applied to a booking.
message OfferInfo {
// The ID of the Offer.
string offer_id = 1;
}
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 booking ID, slot information, user details, and booking status.\u003c/p\u003e\n"],["\u003cp\u003eIt includes optional information like payment details, virtual session details, and details about any applied offers.\u003c/p\u003e\n"],["\u003cp\u003eOfferInfo provides details about an offer applied to a booking, identified by its offer ID.\u003c/p\u003e\n"]]],["A Booking represents an appointment for an inventory slot, identified by a unique `booking_id`. It requires a `slot`, `user_information`, and `status`. Optional data includes `payment_information` and `virtual_session_info`. If an offer was applied, `offer_info` containing the `offer_id` must be included. Bookings are created or modified, with cancellation being a separate update. `OfferInfo` holds the `offer_id` of any offer applied to a booking.\n"],null,["# Booking definition\n\nA Booking is an appointment for an inventory slot. It contains the\ninformation needed to identify and make the appointment.\n\n### Booking Definition\n\n```scilab\n// A booking for an inventory slot\nmessage Booking {\n // ID of this booking, which must be unique across all bookings. (required)\n string booking_id = 1;\n\n // The appointment slot of this booking\n // (required for CreateBooking and UpdateBooking:modify,\n // 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 // Information about the Offer applied to this booking.\n //\n // Required in CreateBookingResponse if an offer_id was set on the\n // CreateBookingRequest that created the Booking.\n OfferInfo offer_info = 7;\n}\n```\n\n### OfferInfo Definition\n\n```scilab\n// Information about an Offer applied to a booking.\nmessage OfferInfo {\n // The ID of the Offer.\n string offer_id = 1;\n}\n```"]]