REST Resource: notification.partners.bookings

Recurso: reserva

Reserva para um espaço de inventário

Representação 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

Nome do recurso da reserva: partners/{partner ID}/bookings/{booking ID}
merchantId

string

ID do comerciante para o espaço
serviceId

string

ID do serviço do comerciante
startTime

string (Timestamp format)

Início do horário disponível

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

Duração do horário disponível

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
clientInformation

object (ClientInformation)

Informações pessoais do cliente que está fazendo o agendamento
status

enum (BookingStatus)

Status da reserva
paymentInformation

object (PaymentInformation)

Informações sobre transações de pagamento relacionadas à reserva.
partySize

string (int64 format)

Tamanho do grupo da reserva

ClientInformation

Informações pessoais sobre a pessoa que fez a reserva

Representação JSON 
{
  "givenName": string,
  "familyName": string,
  "address": {
    object (PostalAddress)
  },
  "telephone": string,
  "email": string
}
Campos
givenName

string

Nome do cliente
familyName

string

Sobrenome do cliente
address

object (PostalAddress)

Endereço do cliente
telephone

string

Número de telefone do cliente
email

string

Endereço de e-mail do cliente

BookingStatus

Status de uma reserva

Enums
BOOKING_STATUS_UNSPECIFIED Não especificado.
CONFIRMED A reserva foi confirmada.
PENDING_MERCHANT_CONFIRMATION O comerciante precisa confirmar a reserva para que o status mude para CONFIRMED (esse fluxo NÃO é compatível no momento).
PENDING_CLIENT_CONFIRMATION O cliente precisa confirmar a reserva para que o status mude para CONFIRMED (esse fluxo NÃO é compatível no momento).
CANCELED A reserva foi cancelada em nome do usuário.
NO_SHOW O cliente não compareceu ao evento.
NO_SHOW_PENALIZED O cliente não compareceu ao evento e violou a política de cancelamento.
FAILED Não foi possível concluir a reserva devido a uma falha de processamento.
DECLINED_BY_MERCHANT A reserva foi recusada de forma assíncrona pelo comerciante.

PaymentInformation

Detalhes de pagamento relacionados a uma reserva

Representação JSON 
{
  "prepaymentStatus": enum (PrepaymentStatus),
  "paymentTransactionId": string
}
Campos
prepaymentStatus

enum (PrepaymentStatus)

Status de pré-pagamento da reserva. Se o prepaymentStatus for PREPAYMENT_PROVIDED ou PREPAYMENT_REFUNDED, o paymentTransactionId terá o código da transação exclusivo associado.
paymentTransactionId

string

Identificador exclusivo de uma transação de pagamento associada à reserva. Se não for aplicável, esse campo estará vazio.

PrepaymentStatus

Status de pré-pagamento de uma reserva.

Enums
PREPAYMENT_STATUS_UNSPECIFIED Se esse campo não for especificado, o padrão será PREPAYMENT_NOT_PROVIDED.
PREPAYMENT_PROVIDED A taxa da reserva foi paga antecipadamente.
PREPAYMENT_NOT_PROVIDED A taxa da reserva não foi paga antecipadamente.
PREPAYMENT_REFUNDED A taxa era representada por PREPAYMENT_PROVIDED, mas foi reembolsada.

Métodos

patch

 Atualiza um Booking existente.