REST Resource: notification.partners.bookings

משאב: הזמנה

הזמנה של משבצת מלאי

ייצוג 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

המזהה של המוכר במשבצת
serviceId

string

המזהה של שירות המוכר
startTime

string (Timestamp format)

שעת ההתחלה של המשבצת לפגישה

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

משך המשבצת לפגישה ששוריינה

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'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

הסטטוס של ההזמנה

טיפוסים בני מנייה (enum)
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)

סטטוס התשלום מראש של ההזמנה. אם הסטטוס של התשלום מראש הוא PREPAYMENT_PROVIDED או PREPAYMENT_REFUNDED, הערך של paymentTransactionId מכיל את מזהה העסקה הייחודי שמשויך לחשבון.
paymentTransactionId

string

מזהה ייחודי של עסקת תשלום שמשויכת להזמנה. ריק אם לא רלוונטי.

PrepaymentStatus

סטטוס התשלום מראש של ההזמנה.

טיפוסים בני מנייה (enum)
PREPAYMENT_STATUS_UNSPECIFIED לא צוין. ברירת המחדל היא PREPAYMENT_NOT_PROVIDED.
PREPAYMENT_PROVIDED העמלה על ההזמנה שולמה מראש.
PREPAYMENT_NOT_PROVIDED לא שולם מראש עבור ההזמנה הזו.
PREPAYMENT_REFUNDED העמלה הייתה בעבר PREPAYMENT_PROVIDED, אבל עכשיו הוחזרה.

שיטות

patch

 מתבצע עדכון של Booking קיים.