REST Resource: notification.partners.bookings

Ressource: Booking

Eine Buchung für einen Inventar-Slot

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

string

Ressourcenname der Buchung: partners/{partner ID}/bookings/{booking ID}

merchantId

string

ID des Händlers für den Slot

serviceId

string

ID der Dienstleistung des Händlers

startTime

string (Timestamp format)

Startzeit des Slots (Zeitblocks).

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

duration

string (Duration format)

Dauer des Slots.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".

clientInformation

object (ClientInformation)

Personenbezogene Daten des Kunden, der den Termin bucht

status

enum (BookingStatus)

Status der Buchung

paymentInformation

object (PaymentInformation)

Informationen zu Zahlungstransaktionen, die sich auf die Buchung beziehen.

partySize

string (int64 format)

Gruppengröße der Buchung

ClientInformation

Personenbezogene Daten der Person, die eine Buchung vornimmt

JSON-Darstellung
{
  "givenName": string,
  "familyName": string,
  "address": {
    object (PostalAddress)
  },
  "telephone": string,
  "email": string
}
Felder
givenName

string

Vorname des Kunden

familyName

string

Nachname des Kunden

address

object (PostalAddress)

Adresse des Kunden

telephone

string

Telefonnummer des Kunden

email

string

E-Mail-Adresse des Kunden

BookingStatus

Status einer Buchung

Optionen
BOOKING_STATUS_UNSPECIFIED Nicht angegeben
CONFIRMED Die Buchung wurde bestätigt.
PENDING_MERCHANT_CONFIRMATION Die Buchung wartet auf die Bestätigung des Händlers, bevor sie in den Status CONFIRMED wechseln kann. Diese Option wird derzeit NICHT unterstützt.
PENDING_CLIENT_CONFIRMATION Die Buchung wartet auf die Bestätigung des Kunden, bevor sie in den Status CONFIRMED wechseln kann. Diese Option wird derzeit NICHT unterstützt.
CANCELED Die Buchung wurde im Namen des Nutzers storniert.
NO_SHOW Der Kunde ist nicht zum Termin erschienen.
NO_SHOW_PENALIZED Der Kunde ist nicht zum Termin erschienen und hat damit gegen die Stornierungsrichtlinien verstoßen.
FAILED Die Buchung konnte aufgrund eines Verarbeitungsfehlers nicht abgeschlossen werden.
DECLINED_BY_MERCHANT Die Buchung wurde vom Händler asynchron abgelehnt.

PaymentInformation

Zahlungsdetails, die sich auf eine Buchung beziehen

JSON-Darstellung
{
  "prepaymentStatus": enum (PrepaymentStatus),
  "paymentTransactionId": string
}
Felder
prepaymentStatus

enum (PrepaymentStatus)

Vorauszahlungsstatus der Buchung. Wenn "prepaymentStatus" auf PREPAYMENT_PROVIDED oder PREPAYMENT_REFUNDED gesetzt ist, enthält "paymentTransactionId" die zugehörige eindeutige Transaktions-ID.

paymentTransactionId

string

Eindeutige ID für eine Zahlungstransaktion der Buchung. Wenn nicht zutreffend, ist das Feld leer.

PrepaymentStatus

Vorauszahlungsstatus einer Buchung

Optionen
PREPAYMENT_STATUS_UNSPECIFIED Nicht angegeben. Wird standardmäßig auf PREPAYMENT_NOT_PROVIDED gesetzt.
PREPAYMENT_PROVIDED Die Buchungsgebühr wurde im Voraus bezahlt.
PREPAYMENT_NOT_PROVIDED Die Buchungsgebühr wurde nicht im Voraus bezahlt.
PREPAYMENT_REFUNDED Der Status für die Buchungsgebühr war zuvor PREPAYMENT_PROVIDED, die Vorauszahlung wurde aber inzwischen erstattet.

Methoden

patch

Aktualisiert eine vorhandene Buchung (Booking)