REST Resource: notification.partners.bookings

リソース: Booking

予約枠の予約

JSON 表現 
{
  "name": string,
  "merchantId": string,
  "serviceId": string,
  "startTime": string,
  "duration": string,
  "clientInformation": {
    object (ClientInformation)
  },
  "status": enum (BookingStatus),
  "paymentInformation": {
    object (PaymentInformation)
  },
  "partySize": string
}
フィールド
name

string

予約のリソース名: partners/{partner ID}/bookings/{booking ID}
merchantId

string

予約枠の販売者 ID
serviceId

string

販売者サービスの ID
startTime

string (Timestamp format)

予約枠の開始時刻

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
duration

string (Duration format)

予約枠の期間

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
clientInformation

object (ClientInformation)

予約を行っている顧客の個人情報
status

enum (BookingStatus)

予約のステータス
paymentInformation

object (PaymentInformation)

予約に関連する支払い処理に関する情報。
partySize

string (int64 format)

予約の人数

ClientInformation

予約者の個人情報

JSON 表現 
{
  "givenName": string,
  "familyName": string,
  "address": {
    object (PostalAddress)
  },
  "telephone": string,
  "email": string
}
フィールド
givenName

string

顧客の名前
familyName

string

顧客の姓
address

object (PostalAddress)

クライアントの住所
telephone

string

クライアントの電話番号
email

string

クライアントのメールアドレス

BookingStatus

予約のステータス

列挙型
BOOKING_STATUS_UNSPECIFIED 指定されていません。
CONFIRMED 予約が確認されました。
PENDING_MERCHANT_CONFIRMATION 予約は、CONFIRMED ステータスへの移行前の販売者による確認待ちです（現在サポートされていません）。
PENDING_CLIENT_CONFIRMATION 予約は、CONFIRMED ステータスへの移行前の顧客による確認待ちです（現在サポートされていません）。
CANCELED ユーザーに代わって予約がキャンセルされました。
NO_SHOW 予約が顧客により無断キャンセルされました。
NO_SHOW_PENALIZED 予約が顧客により無断キャンセルされ、キャンセル ポリシー違反となりました。
FAILED 処理に失敗したため、予約を完了できませんでした。
DECLINED_BY_MERCHANT 予約は販売者によって非同期的に拒否されました。

PaymentInformation

予約に関する支払いの詳細

JSON 表現 
{
  "prepaymentStatus": enum (PrepaymentStatus),
  "paymentTransactionId": string
}
フィールド
prepaymentStatus

enum (PrepaymentStatus)

予約の前払いステータス。prepaymentStatus が PREPAYMENT_PROVIDED または PREPAYMENT_REFUNDED の場合、paymentTransactionId には関連付けられた一意の取引 ID が含まれます。
paymentTransactionId

string

予約に関連付けられた支払い処理の一意の識別子。該当しない場合は空白のままにします。

PrepaymentStatus

予約の前払いステータス。

列挙型
PREPAYMENT_STATUS_UNSPECIFIED 指定されていない場合、デフォルトは PREPAYMENT_NOT_PROVIDED です。
PREPAYMENT_PROVIDED 予約料金は前払いされています。
PREPAYMENT_NOT_PROVIDED 予約料金は前払いされていません。
PREPAYMENT_REFUNDED 料金は以前に PREPAYMENT_PROVIDED でしたが、現在は払い戻されています。

Methods

patch

 既存の Booking を更新します。