REST Resource: notification.partners.bookings

Recurso: Booking

Es la reserva de un horario disponible del inventario.

Representación JSON 
{
  "name": string,
  "merchantId": string,
  "serviceId": string,
  "startTime": string,
  "duration": string,
  "clientInformation": {
    object (ClientInformation)
  },
  "status": enum (BookingStatus),
  "paymentInformation": {
    object (PaymentInformation)
  },
  "partySize": string
}
Campos
name

string

Nombre del recurso de la reserva: partners/{partner ID}/bookings/{booking ID}
merchantId

string

ID del comercio para el horario disponible
serviceId

string

ID del servicio del comercio
startTime

string (Timestamp format)

Es la hora de inicio del horario disponible.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

Es la duración del espacio disponible.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
clientInformation

object (ClientInformation)

Información personal del cliente que programa la cita
status

enum (BookingStatus)

Estado de la reserva
paymentInformation

object (PaymentInformation)

Es la información sobre las transacciones de pago relacionadas con la reserva.
partySize

string (int64 format)

Tamaño del grupo de la reserva

ClientInformation

Es la información personal sobre el usuario que hace una reserva.

Representación JSON 
{
  "givenName": string,
  "familyName": string,
  "address": {
    object (PostalAddress)
  },
  "telephone": string,
  "email": string
}
Campos
givenName

string

Nombre del cliente
familyName

string

Apellido del cliente
address

object (PostalAddress)

Dirección del cliente
telephone

string

Número de teléfono del cliente
email

string

Dirección de correo electrónico del cliente

BookingStatus

Es el estado de una reserva.

Enumeraciones
BOOKING_STATUS_UNSPECIFIED No se especifica.
CONFIRMED Se confirmó la reserva.
PENDING_MERCHANT_CONFIRMATION La reserva tiene pendiente la confirmación del comercio para que se pueda pasar al estado CONFIRMED (NO se admite actualmente).
PENDING_CLIENT_CONFIRMATION La reserva tiene pendiente la confirmación del cliente para que se pueda pasar al estado CONFIRMED (NO se admite actualmente).
CANCELED Se canceló la reserva en nombre del usuario.
NO_SHOW El cliente no se presentó a la cita.
NO_SHOW_PENALIZED El cliente no se presentó a la cita, lo que incumple la política de cancelación.
FAILED No se pudo completar la reserva debido a un error de procesamiento.
DECLINED_BY_MERCHANT El comercio rechazó la reserva de forma asíncrona.

PaymentInformation

Son los detalles del pago relacionados con una reserva.

Representación JSON 
{
  "prepaymentStatus": enum (PrepaymentStatus),
  "paymentTransactionId": string
}
Campos
prepaymentStatus

enum (PrepaymentStatus)

Es el estado del prepago de la reserva. Si el campo prepaymentStatus se establece en PREPAYMENT_PROVIDED o PREPAYMENT_REFUNDED, paymentTransactionId contendrá el ID de transacción único asociado.
paymentTransactionId

string

Es el identificador único de una transacción de pago asociada con la reserva. Este campo estará vacío si no es aplicable.

PrepaymentStatus

Es el estado del prepago de una reserva.

Enumeraciones
PREPAYMENT_STATUS_UNSPECIFIED Si no se especifica, la configuración predeterminada será PREPAYMENT_NOT_PROVIDED.
PREPAYMENT_PROVIDED La tarifa de la reserva se pagó por adelantado.
PREPAYMENT_NOT_PROVIDED La tarifa de la reserva no se pagó por adelantado.
PREPAYMENT_REFUNDED Antes la tarifa era del tipo PREPAYMENT_PROVIDED, pero ahora se reembolsó.

Métodos

patch

 Actualiza un Booking existente.