Metode UpdateBooking

Klien menggunakan UpdateBooking untuk mengubah atau membatalkan pemesanan yang ada.

Jika memperbarui pemesanan gagal karena error logika bisnis, error ini harus dicantumkan dalam respons. Lihat Kegagalan Pemesanan untuk mendapatkan informasi mendetail.

Kirim Permintaan

UpdateBookingRequest

Pesan permintaan berisi informasi yang diperbarui di kolom pemesanan, dan mencantumkan jalur semua kolom pemesanan yang akan diperbarui di kolom update_mask. Misalnya, kolom update_mask dari permintaan yang menjadwalkan ulang pemesanan yang ada berisi dua jalur berikut:

  paths: "slot.start_time"
  paths: "slot.duration"

Lihat FieldMask untuk mendapatkan informasi tambahan.

Nilai yang ditampilkan

UpdateBookingResponse

Kode error gRPC kanonis

• INVALID_ARGUMENT (jika mask kolom yang diberikan berisi nilai yang tidak valid atau salah satu kolom Pemesanan yang diperbarui tidak valid)
• NOT_FOUND (jika ID pemesanan yang diberikan tidak diketahui oleh partner)

// Request to update a [ext.maps.booking.partner.v2.Booking]
message UpdateBookingRequest {
  // Field mask of all booking fields to be updated (optional)
  google.protobuf.FieldMask update_mask = 1;

  // The booking to be updated
  // The following fields can be set in a booking:
  // - status, to cancel a booking.
  // - one of the following is required:
  //   - start_time AND duration in the slot, to reschedule a booking.
  //   - party_size (for dining reservations).
  Booking booking = 2;
}

// Response with the updated [ext.maps.booking.partner.v2.Booking]
message UpdateBookingResponse {
  // The updated booking (required)
  Booking booking = 1;

  // The updated user payment option originally used to pay for this booking.
  // This should be set if the UpdateBookingRequest results in a change to
  // the UserPaymentOption.
  // For instance, if the booking is canceled, the UserPaymentOption should
  // reflect an additional credit to the user. In the case of a multi-use
  // payment option, the current_count should be increased by one to
  // allow the user to create another booking with this payment option. In the
  // case of a single-use payment option, a new single-use user payment option
  // should be returned. (required if altered in update)
  UserPaymentOption user_payment_option = 2;

  // If updating a booking fails, this field should reflect the business logic
  // error (e.g., booking is not cancellable) (required if failure occurs)
  BookingFailure booking_failure = 3;
}