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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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

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

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

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

שיטות

patch

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