REST Resource: notification.partners.bookings

Ressource : Booking

Une réservation pour un créneau d'inventaire

Représentation JSON 
{
  "name": string,
  "merchantId": string,
  "serviceId": string,
  "startTime": string,
  "duration": string,
  "clientInformation": {
    object (ClientInformation)
  },
  "status": enum (BookingStatus),
  "paymentInformation": {
    object (PaymentInformation)
  },
  "partySize": string
}
Champs
name

string

Nom de la ressource associée à la réservation: partners/{partner ID}/bookings/{booking ID}
merchantId

string

ID du marchand associé au créneau
serviceId

string

ID du service du marchand
startTime

string (Timestamp format)

Heure de début du créneau horaire

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

Durée du créneau horaire

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
clientInformation

object (ClientInformation)

Informations personnelles du client prenant rendez-vous
status

enum (BookingStatus)

État de la réservation
paymentInformation

object (PaymentInformation)

Informations sur les transactions de paiement liées à la réservation.
partySize

string (int64 format)

Nombre de personnes pour la réservation

ClientInformation

Informations personnelles sur la personne effectuant la réservation

Représentation JSON 
{
  "givenName": string,
  "familyName": string,
  "address": {
    object (PostalAddress)
  },
  "telephone": string,
  "email": string
}
Champs
givenName

string

Prénom du client
familyName

string

Nom de famille du client
address

object (PostalAddress)

Adresse du client
telephone

string

Numéro de téléphone du client
email

string

Adresse e-mail du client

BookingStatus

État d'une réservation

Énumérations
BOOKING_STATUS_UNSPECIFIED Non spécifié.
CONFIRMED La réservation a été confirmée.
PENDING_MERCHANT_CONFIRMATION La réservation attend la confirmation du marchand avant de pouvoir passer à l'état CONFIRMED (le système n'est PAS encore compatible avec cette fonctionnalité).
PENDING_CLIENT_CONFIRMATION La réservation attend la confirmation du client avant de pouvoir passer à l'état CONFIRMED (le système n'est PAS encore compatible avec cette fonctionnalité).
CANCELED La réservation a été annulée au nom de l'utilisateur.
NO_SHOW Le client ne s'est pas présenté au rendez-vous.
NO_SHOW_PENALIZED Le client ne s'est pas présenté au rendez-vous et a donc enfreint les modalités d'annulation.
FAILED La réservation a échoué en raison d'un problème au niveau du traitement.
DECLINED_BY_MERCHANT La réservation a été refusée de manière asynchrone par le marchand.

PaymentInformation

Détails du paiement lié à une réservation.

Représentation JSON 
{
  "prepaymentStatus": enum (PrepaymentStatus),
  "paymentTransactionId": string
}
Champs
prepaymentStatus

enum (PrepaymentStatus)

État du pré-paiement de la réservation. Si prepaymentStatus est défini sur PREPAYMENT_PROVIDED ou sur PREPAYMENT_REFUNDED, alors paymentTransactionId contient l'ID de transaction unique associé.
paymentTransactionId

string

Identifiant unique d'une transaction de paiement associée à la réservation. Vide si non applicable.

PrepaymentStatus

État du pré-paiement d'une réservation.

Énumérations
PREPAYMENT_STATUS_UNSPECIFIED Non spécifié. La valeur par défaut est PREPAYMENT_NOT_PROVIDED.
PREPAYMENT_PROVIDED Les frais de réservation ont été réglés à l'avance.
PREPAYMENT_NOT_PROVIDED Les frais de réservation n'ont pas été réglés à l'avance.
PREPAYMENT_REFUNDED Les frais affichaient auparavant l'état PREPAYMENT_PROVIDED, mais ils ont maintenant été remboursés.

Méthodes

patch

 Met à jour une valeur Booking existante.