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)

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

הפלט שנוצר תמיד יהיה בפורמט 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)

משך הזמן של המשבצת לפגישה

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

string

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

PrepaymentStatus

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

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

Methods

patch

 מעדכן Booking קיים.