REST Resource: notification.partners.bookings

Risorsa: prenotazione

Una prenotazione per uno spazio di inventario

Rappresentazione JSON
{
  "name": string,
  "merchantId": string,
  "serviceId": string,
  "startTime": string,
  "duration": string,
  "clientInformation": {
    object (ClientInformation)
  },
  "status": enum (BookingStatus),
  "paymentInformation": {
    object (PaymentInformation)
  },
  "partySize": string
}
Campi
name

string

Nome della risorsa della prenotazione: partners/{partner ID}/bookings/{booking ID}

merchantId

string

ID del commerciante per l'area

serviceId

string

ID del servizio del commerciante

startTime

string (Timestamp format)

Ora di inizio dello spazio per appuntamenti

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

duration

string (Duration format)

Durata dello spazio per appuntamenti

Durata in secondi con un massimo di nove cifre frazionarie e termina con "s". Esempio: "3.5s".

clientInformation

object (ClientInformation)

Informazioni personali del cliente che fissa l'appuntamento

status

enum (BookingStatus)

Stato della prenotazione

paymentInformation

object (PaymentInformation)

Informazioni sulle transazioni di pagamento relative alla prenotazione.

partySize

string (int64 format)

Numero di persone della prenotazione

ClientInformation

Informazioni personali della persona che effettua una prenotazione

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

string

Nome del cliente

familyName

string

Cognome del cliente

address

object (PostalAddress)

Indirizzo del client

telephone

string

Numero di telefono del cliente

email

string

Indirizzo email del cliente

BookingStatus

Stato di una prenotazione

Enum
BOOKING_STATUS_UNSPECIFIED Non specificato.
CONFIRMED La prenotazione è stata confermata
PENDING_MERCHANT_CONFIRMATION La prenotazione è in attesa di conferma da parte del commerciante prima di poter passare allo stato CONFERMATO (questa opzione NON è attualmente supportata)
PENDING_CLIENT_CONFIRMATION La prenotazione è in attesa di conferma da parte del cliente prima di poter passare allo stato CONFERMATO (questa opzione NON è attualmente supportata)
CANCELED La prenotazione è stata annullata per conto dell'utente.
NO_SHOW Il cliente non si è presentato all'appuntamento
NO_SHOW_PENALIZED Il cliente non si è presentato per l'appuntamento in violazione delle norme sull'annullamento.
FAILED Impossibile completare la prenotazione a causa di un errore di elaborazione.
DECLINED_BY_MERCHANT La prenotazione è stata rifiutata in modo asincrono dal commerciante.

PaymentInformation

Dettagli sul pagamento relativi a una prenotazione

Rappresentazione JSON
{
  "prepaymentStatus": enum (PrepaymentStatus),
  "paymentTransactionId": string
}
Campi
prepaymentStatus

enum (PrepaymentStatus)

Stato del pagamento anticipato della prenotazione. Se prepaymentStatus è PREPAYMENT_PROVIDED o PREPAYMENT_REFUNDED, paymentTransactionId contiene l'ID transazione univoco associato.

paymentTransactionId

string

Identificatore univoco di una transazione di pagamento associata alla prenotazione. Vuoto se non applicabile.

PrepaymentStatus

Stato del pagamento anticipato di una prenotazione.

Enum
PREPAYMENT_STATUS_UNSPECIFIED Se non specificato, il valore predefinito è PREPAYMENT_NOT_PROVIDED.
PREPAYMENT_PROVIDED La tariffa della prenotazione è stata pagata in anticipo.
PREPAYMENT_NOT_PROVIDED La tariffa della prenotazione non è stata pagata in anticipo.
PREPAYMENT_REFUNDED La tariffa era precedentemente PREPAYMENT_PROVIDED, ma ora è stata rimborsata.

Metodi

patch

Consente di aggiornare un elemento Booking esistente.