עדכון שיטת ההזמנה

הלקוח משתמש ב-UpdateBooking כדי לשנות או לבטל הזמנה קיימת.

אם עדכון ההזמנה נכשל בגלל שגיאה בהיגיון עסקי, התשובה אמורה לכלול את השגיאה. למידע מפורט, קראו את המאמר כישלון בהזמנות.

בקשה

עדכון הזמנה

הודעת בקשה מכילה מידע מעודכן בשדה ההזמנה, ובשדה update_mask מופיעה רשימה של הנתיבים בכל השדות של ההזמנה לעדכון. לדוגמה, השדה update_mask של בקשה המתוזמנת מחדש של הזמנה קיימת מכיל את שני הנתיבים הבאים:

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

למידע נוסף, ראו FieldMask.

הערך המוחזר

עדכון התשובה להזמנה

קודי שגיאה קנוניים ב-gRPC

• INVALID_ARGUMENT (אם מסכת השדות שסופקה מכילה ערכים לא חוקיים או אחד מהשדות המעודכנים של ההזמנה לא חוקי)
• NOT_FOUND (אם מזהה ההזמנה שסיפקתם לא ידוע לשותף)

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