# REST Resource: notification.partners.bookings

- [Resource: Booking](https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#Booking)
  - [JSON representation](https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#Booking.SCHEMA_REPRESENTATION)
- [ClientInformation](https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#ClientInformation)
  - [JSON representation](https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#ClientInformation.SCHEMA_REPRESENTATION)
- [BookingStatus](https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#BookingStatus)
- [PaymentInformation](https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#PaymentInformation)
  - [JSON representation](https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#PaymentInformation.SCHEMA_REPRESENTATION)
- [PrepaymentStatus](https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#PrepaymentStatus)
- [Methods](https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#METHODS_SUMMARY)

## Resource: Booking

A booking for an inventory slot

| JSON representation |
|---|
| ``` { "name": string, "merchantId": string, "serviceId": string, "startTime": string, "duration": string, "clientInformation": { object (`https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#ClientInformation`) }, "status": enum (`https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#BookingStatus`), "paymentInformation": { object (`https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#PaymentInformation`) }, "partySize": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Resource name of the booking: `partners/{partner ID}/bookings/{booking ID}` |
| `merchantId` | `string` ID of the merchant for the slot |
| `serviceId` | `string` ID of the merchant service |
| `startTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Start time of the appointment slot Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `duration` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#duration` format)`` Duration of the appointment slot A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `"3.5s"`. |
| `clientInformation` | ``object (`https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#ClientInformation`)`` Personal information of the client making the appointment |
| `status` | ``enum (`https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#BookingStatus`)`` Status of the booking |
| `paymentInformation` | ``object (`https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#PaymentInformation`)`` Information about payment transactions that relate to the booking. |
| `partySize` | `string (https://developers.google.com/discovery/v1/type-format format)` Party size of the booking |

## ClientInformation

Personal information about the person making a booking

| JSON representation |
|---|
| ``` { "givenName": string, "familyName": string, "address": { object (`https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/PostalAddress`) }, "telephone": string, "email": string } ``` |

| Fields ||
|---|---|
| `givenName` | `string` Given name of the client |
| `familyName` | `string` Family name of the client |
| `address` | ``object (`https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/PostalAddress`)`` Address of the client |
| `telephone` | `string` Phone number of the client |
| `email` | `string` Email address of the client |

## BookingStatus

Status of a booking

| Enums ||
|---|---|
| `BOOKING_STATUS_UNSPECIFIED` | Not specified. |
| `CONFIRMED` | Booking has been confirmed |
| `PENDING_MERCHANT_CONFIRMATION` | Booking is awaiting confirmation by the merchant before it can transition into CONFIRMED status (this is NOT currently supported) |
| `PENDING_CLIENT_CONFIRMATION` | Booking is awaiting confirmation by the client before it can transition into CONFIRMED status (this is NOT currently supported) |
| `CANCELED` | Booking has been canceled on behalf of the user. |
| `NO_SHOW` | Client did not show for the appointment |
| `NO_SHOW_PENALIZED` | Client did not show for the appointment in violation of the cancellation policy. |
| `FAILED` | Booking could not be completed due to a processing failure. |
| `DECLINED_BY_MERCHANT` | Booking was asynchronously declined by the merchant. |

## PaymentInformation

Payment details that relate to a booking

| JSON representation |
|---|
| ``` { "prepaymentStatus": enum (`https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#PrepaymentStatus`), "paymentTransactionId": string } ``` |

| Fields ||
|---|---|
| `prepaymentStatus` | ``enum (`https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#PrepaymentStatus`)`` Prepayment status of the booking. If the prepaymentStatus is PREPAYMENT_PROVIDED or PREPAYMENT_REFUNDED, then paymentTransactionId contains the associated unique transaction id. |
| `paymentTransactionId` | `string` Unique identifier for a payment transaction associated with the booking. Empty if not applicable. |

## PrepaymentStatus

Prepayment status of a booking.

| Enums ||
|---|---|
| `PREPAYMENT_STATUS_UNSPECIFIED` | Not specified, defaults to PREPAYMENT_NOT_PROVIDED. |
| `PREPAYMENT_PROVIDED` | The fee for the booking has been paid in advance. |
| `PREPAYMENT_NOT_PROVIDED` | The fee for the booking has not been paid in advance. |
| `PREPAYMENT_REFUNDED` | The fee was previously PREPAYMENT_PROVIDED but has now been refunded. |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings/patch` | Updates an existing `https://developers.google.com/maps-booking/reference/maps-booking-api/rest/v1alpha/notification.partners.bookings#Booking`. |