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

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

string

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

string (Timestamp format)

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

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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)

סטטוס התשלום מראש של ההזמנה. אם הערך של 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 אבל עכשיו בוצע החזר כספי.

Methods

patch

 עדכון של Booking קיים.