ListBookings method

  • The described method retrieves future bookings for a user at any merchant, specifically excluding past or cancelled bookings.

  • The ListBookingsRequest requires a user_id to identify the user whose bookings are being queried.

  • The ListBookingsResponse returns a list of Booking objects representing all the user's requested bookings.

This method returns future bookings for a user at any merchant. This method should not return past bookings or cancelled bookings.

Request

ListBookingsRequest

Return value

ListBookingsResponse

// Request to list all bookings for a user
message ListBookingsRequest {
  option features.(pb.java).nest_in_file_class = YES;

  // ID of the user (required)
  string user_id = 1 [
    features.field_presence = IMPLICIT,
    features.(pb.cpp).string_type = STRING
  ];
}

// Response for the ListBookings RPC with all bookings for the requested user.
message ListBookingsResponse {
  option features.(pb.java).nest_in_file_class = YES;

  // All bookings of the user (required)
  repeated Booking bookings = 1;
}