REST Resource: notification.partners.bookings

Resource: 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)

預約時段的開始時間

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
duration

string (Duration format)

預約時段的時間長度。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："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 預訂正在等待商家確認，確認後才能轉換至「已確認」狀態 (目前「不」支援這個項目)
PENDING_CLIENT_CONFIRMATION 預訂正在等待客戶確認，確認後才能轉換至「已確認」狀態 (目前「不」支援這個項目)
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

與預訂相關聯的唯一付款交易 ID。不適用則留空。

PrepaymentStatus

某次預訂的預付狀態。

列舉
PREPAYMENT_STATUS_UNSPECIFIED 未指定，預設為 PREPAYMENT_NOT_PROVIDED。
PREPAYMENT_PROVIDED 預訂費用已預先支付。
PREPAYMENT_NOT_PROVIDED 預訂費用尚未預先支付。
PREPAYMENT_REFUNDED 費用先前為 PREPAYMENT_PROVIDED，但現在已退還。

方法

patch

 更新現有的 Booking。