GetBookingStatus method

  • GetBookingStatusRequest retrieves the status and prepayment status of a booking using the booking ID.

  • GetBookingStatusResponse returns the booking ID, booking status (BookingStatus), and prepayment status (PrepaymentStatus).

  • If the booking ID is not found, a NOT_FOUND error is returned.

Request

GetBookingStatusRequest

Return value

GetBookingStatusResponse

Canonical gRPC error codes

  • NOT_FOUND (if the provided booking ID is unknown to the partner)
// Request to get booking status and prepayment status for a
// [ext.maps.booking.partner.v2.Booking]
message GetBookingStatusRequest {
  // ID of the existing booking (required)
  string booking_id = 1;
}

// Response for the [ext.maps.booking.partner.v2.GetBookingStatus] RPC with
// booking status and prepayment status
message GetBookingStatusResponse {
  // ID of the booking (required)
  string booking_id = 1;

  // Status of the booking (required)
  BookingStatus booking_status = 2;

  // Prepayment status of the booking (required)
  PrepaymentStatus prepayment_status = 3;
}