REST Resource: notification.partners.bookings

Resource: Booking

A booking for an inventory slot

JSON representation
{
  "name": string,
  "merchantId": string,
  "serviceId": string,
  "startTime": string,
  "duration": string,
  "clientInformation": {
    object(ClientInformation)
  },
  "status": enum(BookingStatus),
  "paymentInformation": {
    object(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 (Timestamp format)

Start time of the appointment slot

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

duration

string (Duration format)

Duration of the appointment slot

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

clientInformation

object(ClientInformation)

Personal information of the client making the appointment

status

enum(BookingStatus)

Status of the booking

paymentInformation

object(PaymentInformation)

Information about payment transactions that relate to the booking.

partySize

string (int64 format)

Party size of the booking

ClientInformation

Personal information about the person making a booking

JSON representation
{
  "givenName": string,
  "familyName": string,
  "address": {
    object(PostalAddress)
  },
  "telephone": string,
  "email": string
}
Fields
givenName

string

Given name of the client

familyName

string

Family name of the client

address

object(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(PrepaymentStatus),
  "paymentTransactionId": string
}
Fields
prepaymentStatus

enum(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

patch

Updates an existing Booking.