GetBookingStatus method

  • The GetBookingStatusRequest is used to retrieve the status and prepayment status of an existing booking.

  • The GetBookingStatusRequest requires a booking_id to identify the booking.

  • The GetBookingStatusResponse returns the booking_id, booking_status, and prepayment_status.

  • A NOT_FOUND error is returned if the provided booking_id is unknown to the partner.

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;
}